feat(core): Add support for functions and globalContext

* Added support for Drupal functions * Added support for Drupal functions - formatting issue fixed * Add tests, use global context instead --------- Co-authored-by: Lee Rowlands <lee.rowlands@previousnext.com.au>
larowlan · Jan 8, 2024 · 1bb619b · 1bb619b
1 parent 9e7de33
commit 1bb619b
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 5 deletions.
diff --git a/src/index.js b/src/index.js
@@ -11,6 +11,7 @@ const defaultOptions = {
   namespaces: {},
   filters: {},
   functions: {},
+  globalContext: {},
   framework: FRAMEWORK_HTML,
   pattern: /\.(twig)(\?.*)?$/,
 }
@@ -113,9 +114,11 @@ const plugin = (options = {}) => {
         }
         let embed,
           embeddedIncludes,
+          functions,
           code,
           includes,
           seen = []
+
         try {
           const result = await compileTemplate(id, id, options).catch(
             errorHandler(id)
@@ -160,6 +163,16 @@ const plugin = (options = {}) => {
                 )}';`
             )
             .join("\n")
+
+          functions = Object.entries(options.functions)
+            .map(([name, value]) => {
+              return `
+              const ${name} = ${value};
+              ${name}(Twig);
+            `
+            })
+            .join("\n")
+
           const includeResult = await Promise.all(includePromises).catch(
             errorHandler(id)
           )
@@ -176,10 +189,11 @@ const plugin = (options = {}) => {
         import DrupalAttribute from 'drupal-attribute';
         import { addDrupalExtensions } from 'drupal-twig-extensions/twig';
         ${frameworkInclude}
-        
+
         ${embed}
 
-        addDrupalExtensions(Twig);
+        ${functions}
+
         // Disable caching.
         Twig.cache(false);
 
@@ -191,7 +205,8 @@ const plugin = (options = {}) => {
           ${includes ? `component.options.allowInlineIncludes = true;` : ""}
           try {
             return frameworkTransform(component.render({
-            attributes: new DrupalAttribute(),
+              attributes: new DrupalAttribute(),
+              ...${JSON.stringify(options.globalContext)},
               ...context
             }));
           }

diff --git a/tests/__snapshots__/smoke.test.js.snap b/tests/__snapshots__/smoke.test.js.snap
@@ -1,5 +1,35 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`Basic smoke test > Should support global context and functions 1`] = `
+"<section>
+  <h1>Include</h1>
+  <article>
+          Lorem ipsum dolor sit amet, consectetur adipisicing elit. At dignissimos fugiat inventore laborum maiores molestiae neque quia quo unde veniam?
+      </article>
+</section>
+<section>
+  <h1>Embed</h1>
+  <article>
+        Lorem ipsum dolor sit amet.
+    <button class=\\"button--primary\\">Nested include</button>
+          IT WORKS!
+        </article>
+</section>
+<section>
+  <h1></h1>
+  <article>
+          Lorem ipsum dolor sit amet, consectetur adipisicing elit. At dignissimos fugiat inventore laborum maiores molestiae neque quia quo unde veniam?
+      </article>
+</section>
+<section>
+  <h1>Relative include</h1>
+  <article>
+          Lorem ipsum dolor sit amet, consectetur adipisicing elit. At dignissimos fugiat inventore laborum maiores molestiae neque quia quo unde veniam?
+      </article>
+</section>
+"
+`;
+
 exports[`Basic smoke test > Should support includes 1`] = `
 "<section>
   <h1>Include</h1>
@@ -12,7 +42,8 @@ exports[`Basic smoke test > Should support includes 1`] = `
   <article>
         Lorem ipsum dolor sit amet.
     <button class=\\"button--primary\\">Nested include</button>
-    </article>
+          IT WORKS!
+        </article>
 </section>
 <section>
   <h1></h1>
@@ -58,7 +89,8 @@ exports[`Basic smoke test > Should support variables 1`] = `
   <article>
         Lorem ipsum dolor sit amet.
     <button class=\\"button--primary\\">Nested include</button>
-    </article>
+          IT WORKS!
+        </article>
 </section>
 <section>
   <h1>Pickle Fixie</h1>

diff --git a/tests/fixtures/mockup.twig b/tests/fixtures/mockup.twig
@@ -3,6 +3,9 @@
   {% block content %}
     Lorem ipsum dolor sit amet.
     {% include "@tests/button.twig" with {text: 'Nested include'} %}
+    {% if active_theme == 'poodles' %}
+      {{ testFunction() }}
+    {% endif %}
   {% endblock %}
 {% endembed %}
 {% include "@tests/section.twig" %}

diff --git a/tests/smoke.test.js b/tests/smoke.test.js
@@ -29,4 +29,10 @@ describe("Basic smoke test", () => {
     expect(markup).toContain("Contact")
     expect(markup).toMatchSnapshot()
   })
+  it("Should support global context and functions", () => {
+    const markup = Markup()
+    expect(markup).toMatchSnapshot()
+    expect(markup).toContain("Nested include")
+    expect(markup).toContain("IT WORKS!")
+  })
 })
diff --git a/vite.config.js b/vite.config.js
@@ -18,6 +18,13 @@ export default defineConfig({
   },
   plugins: [
     twig({
+      globalContext: {
+        active_theme: "poodles",
+      },
+      functions: {
+        testFunction: (instance) =>
+          instance.extendFunction("testFunction", () => "IT WORKS!"),
+      },
       namespaces: {
         tests: join(__dirname, "/tests/fixtures"),
       },