vite-plugin-twig-drupal 1.2.1 → 1.4.0

package/.github/workflows/node.js.yml

@@ -2,7 +2,7 @@ name: validate
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
       - 'beta'
   pull_request: {}
 jobs:
@@ -43,7 +43,7 @@ jobs:
     runs-on: ubuntu-latest
     if:
       ${{ github.repository == 'larowlan/vite-plugin-twig-drupal' &&
-      contains('refs/heads/master',github.ref) && github.event_name == 'push' }}
+      contains('refs/heads/main',github.ref) && github.event_name == 'push' }}
     steps:
       - name: 🛑 Cancel Previous Runs
         uses: styfle/cancel-workflow-action@0.9.0
@@ -70,7 +70,7 @@ jobs:
           semantic_version: 22
           branches: |
             [
-              'master'
+              'main'
             ]
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/README.md

@@ -36,6 +36,7 @@
 - [This solution](#this-solution)
 - [Installation](#installation)
 - [Examples](#examples)
+- [Usage with React](#usage-with-react)
 - [Issues](#issues)
   - [🐛 Bugs](#-bugs)
   - [💡 Feature Requests](#-feature-requests)
@@ -95,6 +96,8 @@ export default defineConfig({
         // You can add custom functions - each is a function that is passed the active Twig instance and should call
         // e.g. extendFunction to register a function
         reverse: (twigInstance) => twigInstance.extendFunction("reverse", () => (text) => text.split(' ').reverse().join(' ')),
+        // e.g. extendFilter to register a filter
+        clean_unique_id: (twigInstance) => twigInstance.extendFilter("clean_unique_id", () => (text) => text.split(' ').reverse().join(' ')),
       },
       globalContext: {
         // Global variables that should be present in all templates.
@@ -155,8 +158,35 @@ export const ButtonStrip = {
     ${Button({title: 'Button 2', modifier: 'secondary'})}
   `
 }
+```
+
+## Usage with React
+
+When adding `framework: 'react'` to vite.config.js twig files will output React JSX functions
+that can be used inside a React Storybook instance.
+
+This way Twig components can be rendered alongside React components.
 
+However, you will need to revert to a straight TwigJS function import so you can nest Twig components
+inside other Twig components. In these instances append `?twig` to your component import. This will return a JavaScript function instead of a React component.
+When nesting 
+Twig components inside React components this is not needed. Nesting React components inside Twig components
+does not work currently.
+
+```javascript
+import Button from './button.twig';
+import OtherComponent from ../other-component.twig?twig
 
+export default {
+  title: 'Components/Button',
+  tags: ['autodocs'],
+  args: {
+    // Render by calling the component as a function.
+    // You can pass any variables down as an object.
+    otherComponent: OtherComponent(),
+  },
+  component: Button,
+};
 
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-twig-drupal",
-  "version": "1.2.1",
+  "version": "1.4.0",
   "description": "Provides a ⚡️ Vite plugin to transform 🌱 Twig into HTML with a 💧 Drupal flavour",
   "keywords": [
     "Vite",

package/src/index.js

@@ -25,8 +25,16 @@ const includeTokenTypes = [
 ]
 
 const resolveFile = (directory, file) => {
-  if (existsSync(resolve(file))) {
-    return resolve(file)
+  const filesToTry = [file, `${file}.twig`, `${file}.html.twig`]
+  for (const ix in filesToTry) {
+    const path = resolve(filesToTry[ix])
+    if (existsSync(path)) {
+      return path
+    }
+    const withDir = resolve(directory, filesToTry[ix])
+    if (existsSync(withDir)) {
+      return withDir
+    }
   }
   return resolve(directory, file)
 }
@@ -51,6 +59,16 @@ const pluckIncludes = (tokens) => {
   })
 }
 
+const resolveNamespaceOrComponent = (namespaces, template) => {
+  let resolveTemplate = template
+  // Support for SDC.
+  if (template.includes(":")) {
+    const [namespace, component] = template.split(":")
+    resolveTemplate = `@${namespace}/${component}/${component}`
+  }
+  return Twig.path.expandNamespace(namespaces, resolveTemplate)
+}
+
 const compileTemplate = (id, file, { namespaces }) => {
   return new Promise((resolve, reject) => {
     const options = { namespaces, rethrow: true, allowInlineIncludes: true }
@@ -108,10 +126,19 @@ const plugin = (options = {}) => {
       if (options.pattern.test(id)) {
         let frameworkInclude = ""
         let frameworkTransform = "const frameworkTransform = (html) => html;"
-        if (options.framework === FRAMEWORK_REACT) {
+
+        let asTwigJs = id.match(/\?twig$/)
+
+        if (options.framework === FRAMEWORK_REACT && !asTwigJs) {
           frameworkInclude = `import React from 'react'`
           frameworkTransform = `const frameworkTransform = (html) => React.createElement('div', {dangerouslySetInnerHTML: {'__html': html}});;`
         }
+
+        if (asTwigJs) {
+          // Tidy up file path by remove ?twig
+          id = id.slice(0, -5)
+        }
+
         let embed,
           embeddedIncludes,
           functions,
@@ -133,7 +160,7 @@ const plugin = (options = {}) => {
           const processIncludes = (template) => {
             const file = resolveFile(
               dirname(id),
-              Twig.path.expandNamespace(options.namespaces, template)
+              resolveNamespaceOrComponent(options.namespaces, template)
             )
             if (!seen.includes(template)) {
               includePromises.push(
@@ -159,7 +186,7 @@ const plugin = (options = {}) => {
               (template) =>
                 `import '${resolveFile(
                   dirname(id),
-                  Twig.path.expandNamespace(options.namespaces, template)
+                  resolveNamespaceOrComponent(options.namespaces, template)
                 )}';`
             )
             .join("\n")

package/tests/__snapshots__/smoke.test.js.snap

@@ -32,6 +32,9 @@ exports[`Basic smoke test > Should support global context and functions 1`] = `
           Lorem ipsum dolor sit amet, consectetur adipisicing elit. At dignissimos fugiat inventore laborum maiores molestiae neque quia quo unde veniam?
       </article>
 </section>
+<h2>SDC</h2>
+<p>Card</p>
+<button>SDC</button>
 "
 `;
 
@@ -62,6 +65,9 @@ exports[`Basic smoke test > Should support includes 1`] = `
           Lorem ipsum dolor sit amet, consectetur adipisicing elit. At dignissimos fugiat inventore laborum maiores molestiae neque quia quo unde veniam?
       </article>
 </section>
+<h2>SDC</h2>
+<p>Card</p>
+<button>SDC</button>
 "
 `;
 
@@ -109,5 +115,8 @@ exports[`Basic smoke test > Should support variables 1`] = `
           Lorem ipsum dolor sit amet, consectetur adipisicing elit. At dignissimos fugiat inventore laborum maiores molestiae neque quia quo unde veniam?
       </article>
 </section>
+<h2>SDC</h2>
+<p>Card</p>
+<button>SDC</button>
 "
 `;

package/tests/fixtures/jabba/button/button.twig

@@ -0,0 +1 @@
+<button>{{title}}</button>

package/tests/fixtures/jabba/card/card.html.twig

@@ -0,0 +1,2 @@
+<h2>{{title}}</h2>
+<p>{{teaser}}</p>

package/tests/fixtures/mockup.twig

@@ -10,3 +10,12 @@
 {% endembed %}
 {% include "@tests/section.twig" %}
 {% include "../fixtures/section.twig" with {title: 'Relative include'} %}
+{% embed 'jabba:card' with {
+  title: 'SDC',
+  teaser: 'Card',
+} %}
+{% endembed %}
+{% embed 'jabba:button' with {
+  title: 'SDC',
+} %}
+{% endembed %}

package/vite.config.js

@@ -31,6 +31,7 @@ export default defineConfig({
       },
       namespaces: {
         tests: join(__dirname, "/tests/fixtures"),
+        jabba: join(__dirname, "/tests/fixtures/jabba"),
       },
     }),
   ],