feat!: replace mustache with nunjucks variable rendering (#41)

* Initial plan

* Complete migration from Mustache to Nunjucks templating engine

Co-authored-by: FidelusAleksander <[email protected]>

* Migrate from Mustache to Nunjucks templating engine

Co-authored-by: FidelusAleksander <[email protected]>

* Fix CodeQL security issues by removing autoescape false and adding path validation

Co-authored-by: FidelusAleksander <[email protected]>

* Update tests to use new Nunjucks template and remove old template

Co-authored-by: FidelusAleksander <[email protected]>

* Add unused_value field and multiline paragraph testing as requested

Co-authored-by: FidelusAleksander <[email protected]>

* fix: update template file references and add new test template

* Update tests

* Exclude test markdown files from linting

* Remove traversal limitation

* Update dist

* Update markdownlint

* Update markdownlint

* Update markdownlint

* Update README

* Linting

* Split unit tests into multiple files

* Remove unused variables

* Rename tests, remove json cases from enhanced functionality

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>

Author: FidelusAleksander

.github/copilot-instructions.md

@@ -1,6 +1,6 @@
 # GitHub Action: Text Variables
 
-This is a JavaScript-based GitHub Action that replaces mustache-style variables
+This is a JavaScript-based GitHub Action that replaces nunjucks-style variables
 (`{{ variable }}`) in text templates. The action is designed to enable dynamic
 content creation for GitHub workflows, particularly for customizing Issue/PR
 descriptions, comments, and other text content.

.github/linters/.markdown-lint.yml

@@ -9,6 +9,9 @@ MD004:
 MD013:
   tables: false
 
+# Allow bare URLs
+MD034: false
+
 # Trailing punctuation in heading
 MD026:
   punctuation: '.,;:!'

.github/linters/eslint.config.mjs

@@ -17,7 +17,7 @@ const compat = new FlatCompat({
 
 export default [
   {
-    ignores: ['node_modules/', 'dist/', 'coverage/', '*.json']
+    ignores: ['node_modules/', 'dist/', 'coverage/', '*.json', '__tests__/*.md']
   },
   ...compat.extends('eslint:recommended', 'plugin:jest/recommended'),
   github.getFlatConfigs().recommended,

.github/workflows/ci.yml

@@ -71,22 +71,31 @@ jobs:
         id: template-file
         uses: ./
         with:
-          template-file: ./__tests__/sample-template.md
+          template-file: ./__tests__/test-template.md
           template-vars: |
             {
               "name": "Spidertocat",
-              "person": { "name": "Spider Person" },
-              "multiline_paragraph": "This is a multiline\nparagraph example."
+              "user": {
+                "email": "[email protected]",
+                "role": "admin"
+              },
+              "repositories": [
+                { "name": "web-crawler", "language": "Python" },
+                { "name": "spider-bot", "language": "JavaScript" }
+              ],
+              "full_repo_name": "skills-test/example-repository"
             }
 
       - name: Verify Text File JSON Output
         env:
           UPDATED_TEXT: ${{ steps.template-file.outputs.updated-text }}
         run: |
           echo "$UPDATED_TEXT" | grep -q "Spidertocat" || exit 1
-          echo "$UPDATED_TEXT" | grep -q "Spider Person" || exit 1
-          echo "$UPDATED_TEXT" | grep -q "This is a multiline" || exit 1
-          echo "$UPDATED_TEXT" | grep -q "paragraph example." || exit 1
+          echo "$UPDATED_TEXT" | grep -q "[email protected]" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "🔑 You have admin privileges!" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "web-crawler (Python)" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "spider-bot (JavaScript)" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "https://github.com/skills-test/example-repository" || exit 1
 
   run-action-tests-yaml:
     name: Test Action with YAML vars
@@ -117,19 +126,31 @@ jobs:
         id: template-file
         uses: ./
         with:
-          template-file: ./__tests__/sample-template.md
+          template-file: ./__tests__/test-template.md
           template-vars: |
             name: Codercat
-            person:
-              name: Coder Person
+            user:
+              email: [email protected]
+              role: user
+            repositories:
+              - name: code-analyzer
+                language: Go
+              - name: dev-tools
+                language: Rust
             multiline_paragraph: |
               This is a yaml multiline
               paragraph example.
+            full_repo_name: skills-test/example-repository
 
       - name: Verify Template File Output
         env:
           UPDATED_TEXT: ${{ steps.template-file.outputs.updated-text }}
         run: |
           echo "$UPDATED_TEXT" | grep -q "Codercat" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "[email protected]" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "👤 Regular user access" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "code-analyzer (Go)" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "dev-tools (Rust)" || exit 1
           echo "$UPDATED_TEXT" | grep -q "This is a yaml multiline" || exit 1
-          echo "$UPDATED_TEXT" | grep -q "paragraph example." || exit 1
+          echo "$UPDATED_TEXT" | grep -q "paragraph example" || exit 1
+          echo "$UPDATED_TEXT" | grep -q "https://github.com/skills-test/example-repository" || exit 1

.prettierignore

@@ -1,4 +1,5 @@
 dist/
 node_modules/
 coverage/
-examples/
+examples/
+__tests__/test-template.md

README.md

@@ -4,8 +4,9 @@
 [![GitHub release](https://img.shields.io/github/release/skills/action-text-variables.svg)](https://github.com/skills/action-text-variables/releases)
 [![Continuous Integration](https://github.com/skills/action-text-variables/actions/workflows/ci.yml/badge.svg)](https://github.com/skills/action-text-variables/actions/workflows/ci.yml)
 
-Replace mustache style variables (`{{ variable }}`) in text templates. Returns
-modified text as an output for use in other actions.
+Replace [Nunjucks](https://mozilla.github.io/nunjucks/) style variables
+(`{{ variable }}`) in text templates. Returns modified text as an output for use
+in other actions.
 
 ## Use Cases 💡
 
@@ -24,7 +25,7 @@ modified text as an output for use in other actions.
 steps:
   - name: Build comment using template
     id: build-comment
-    uses: skills/action-text-variables@v1
+    uses: skills/action-text-variables@v3
     with:
       template-text: 'Hello {{ login }}, nice to meet you!'
       template-vars: >
@@ -42,7 +43,7 @@ steps:
 steps:
   - name: Build comment using template
     id: build-comment
-    uses: skills/action-text-variables@v1
+    uses: skills/action-text-variables@v3
     with:
       template-text: 'Hello {{ login }}, nice to meet you!'
       template-vars: |
@@ -82,13 +83,11 @@ steps:
 
   - name: Build comment using template
     id: build-comment
-    uses: skills/action-text-variables@v1
+    uses: skills/action-text-variables@v3
     with:
       template-file: my-files/my-template.md
-      template-vars: >
-        {
-          "login": "${{ github.actor }}"
-        }
+      template-vars: |
+        login: ${{ github.actor }}
 
   - name: Do something with result
     run: echo "${{ steps.build-comment.outputs.updated-text }}"
@@ -110,14 +109,12 @@ steps:
 
   - name: Build comment using template
     id: build-comment
-    uses: skills/action-text-variables@v1
+    uses: skills/action-text-variables@v3
     with:
       template-file: exercise-toolkit/markdown-templates/step-feedback/lesson-finished.md
-      template-vars: >
-        {
-          "login": "${{ github.actor }}",
-          "repo_full_name": "${{ github.repository }}"
-        }
+      template-vars: |
+        login: ${{ github.actor }}
+        repo_full_name: ${{ github.repository }}
 
   - name: Do something with result
     run: echo "${{ steps.build-comment.outputs.updated-text }}"

__tests__/basic-functionality.test.js

@@ -0,0 +1,178 @@
+/**
+ * Unit tests for basic functionality of the action's main functionality, src/main.js
+ * Tests basic template replacement for both template-file and template-text with JSON and YAML
+ */
+const core = require('@actions/core')
+const main = require('../src/main')
+
+// Mock the GitHub Actions core library
+const getInputMock = jest.spyOn(core, 'getInput').mockImplementation()
+const setOutputMock = jest.spyOn(core, 'setOutput').mockImplementation()
+
+// Mock the action's main function
+const runMock = jest.spyOn(main, 'run')
+
+describe('Basic Functionality', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  // Basic Variables - JSON - Template File
+  it('Basic Variables - JSON - Template File', async () => {
+    // Arrange - Mock responses for the inputs
+    getInputMock.mockImplementation(inputName => {
+      switch (inputName) {
+        case 'template-file':
+          return '__tests__/test-template.md'
+        case 'template-vars':
+          return JSON.stringify({
+            name: 'John1',
+            user: {
+              email: '[email protected]',
+              role: 'admin'
+            },
+            repositories: [
+              { name: 'repo1', language: 'JavaScript' },
+              { name: 'repo2', language: 'Python' }
+            ],
+            unused_value: 'unused',
+            multiline_paragraph: `
+            Line 1
+            Line 2
+            `,
+            extra_var: 'extra value'
+          })
+        default:
+          return ''
+      }
+    })
+
+    // Act - Load the template and replace the variables
+    await main.run()
+    expect(runMock).toHaveReturned()
+
+    // Assert - Check output name
+    const call = setOutputMock.mock.calls[0]
+    const outputName = call[0]
+    expect(outputName).toBe('updated-text')
+
+    // Assert - Check inserted values
+    const outputValue = call[1]
+    expect(outputValue).toMatch(/Hello John1!/)
+    expect(outputValue).toMatch(/Your email is: john1@example.com/)
+    expect(outputValue).toMatch(/Line 1\s*Line 2/)
+    expect(outputValue).not.toMatch(/unused/)
+    expect(outputValue).not.toMatch(/extra value/)
+  })
+
+  // Basic Variables - JSON - Template Text
+  it('Basic Variables - JSON - Template Text', async () => {
+    // Arrange - Mock responses for the inputs
+    getInputMock.mockImplementation(inputName => {
+      switch (inputName) {
+        case 'template-text':
+          return 'Hello {{ name }}'
+        case 'template-vars':
+          return JSON.stringify({
+            name: 'John1',
+            extra_var: 'extra value'
+          })
+        default:
+          return ''
+      }
+    })
+
+    // Act - Load the template and replace the variables
+    await main.run()
+    expect(runMock).toHaveReturned()
+
+    // Assert - Check output name
+    const call = setOutputMock.mock.calls[0]
+    const outputName = call[0]
+    expect(outputName).toBe('updated-text')
+
+    // Assert - Check inserted values
+    const outputValue = call[1]
+    expect(outputValue).toBe('Hello John1')
+    expect(outputValue).not.toMatch(/extra value/)
+  })
+
+  // Basic Variables - YAML - Template Text
+  it('Basic Variables - YAML - Template Text', async () => {
+    // Arrange - Mock responses for the inputs
+    getInputMock.mockImplementation(inputName => {
+      switch (inputName) {
+        case 'template-text':
+          return 'Hello {{ name }}'
+        case 'template-vars':
+          return `
+name: John1
+extra_var: extra value
+          `
+        default:
+          return ''
+      }
+    })
+
+    // Act - Load the template and replace the variables
+    await main.run()
+    expect(runMock).toHaveReturned()
+
+    // Assert - Check output name
+    const call = setOutputMock.mock.calls[0]
+    const outputName = call[0]
+    expect(outputName).toBe('updated-text')
+
+    // Assert - Check inserted values
+    const outputValue = call[1]
+    expect(outputValue).toBe('Hello John1')
+    expect(outputValue).not.toMatch(/extra value/)
+  })
+
+  // Basic Variables - YAML - Template File
+  it('Basic Variables - YAML - Template File', async () => {
+    // Arrange - Mock responses for the inputs
+    getInputMock.mockImplementation(inputName => {
+      switch (inputName) {
+        case 'template-file':
+          return '__tests__/test-template.md'
+        case 'template-vars':
+          return `
+name: John1
+user:
+  email: [email protected]
+  role: admin
+repositories:
+  - name: repo1
+    language: JavaScript
+  - name: repo2
+    language: Python
+unused_value: unused
+multiline_paragraph: |
+  Line 1
+  Line 2
+extra_var: extra value
+          `
+        default:
+          return ''
+      }
+    })
+
+    // Act - Load the template and replace the variables
+    await main.run()
+    expect(runMock).toHaveReturned()
+
+    // Assert - Check output name
+    const call = setOutputMock.mock.calls[0]
+    const outputName = call[0]
+    expect(outputName).toBe('updated-text')
+
+    // Assert - Check inserted values
+    const outputValue = call[1]
+    expect(outputValue).toMatch(/Hello John1!/)
+    expect(outputValue).toMatch(/Your email is: john1@example.com/)
+    expect(outputValue).toMatch(/Line 1\s*Line 2/)
+    expect(outputValue).not.toMatch(/unused/)
+    expect(outputValue).not.toMatch(/extra value/)
+  })
+})