@bookshop/hugo-engine 3.4.0-beta.1 → 3.4.0-beta.2

package/.nyc_output/processinfo/{4266a04d-f79f-4e25-82b5-a5503aad4653.json → 0d71b778-7933-4ad7-b3a3-a0ab8fb25087.json}

@@ -1 +1 @@
-{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","pid":5612,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907492168,"ppid":5578,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/4266a04d-f79f-4e25-82b5-a5503aad4653.json","externalId":"","uuid":"4266a04d-f79f-4e25-82b5-a5503aad4653","files":[]}
+{"parent":"288189b4-5618-4616-9a86-8209c52bfa78","pid":5524,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670976826633,"ppid":5513,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/0d71b778-7933-4ad7-b3a3-a0ab8fb25087.json","externalId":"","uuid":"0d71b778-7933-4ad7-b3a3-a0ab8fb25087","files":[]}

package/.nyc_output/processinfo/288189b4-5618-4616-9a86-8209c52bfa78.json

@@ -0,0 +1 @@
+{"parent":null,"pid":5513,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/cli.js","-v"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670976826223,"ppid":5502,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/288189b4-5618-4616-9a86-8209c52bfa78.json","externalId":"","uuid":"288189b4-5618-4616-9a86-8209c52bfa78","files":[]}

package/.nyc_output/processinfo/{6dd4f497-4c32-412e-906a-d5f84380dee6.json → 3a20cbf5-03a8-4e28-9134-bcbe4e3999da.json}

@@ -1 +1 @@
-{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","pid":5611,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907492165,"ppid":5578,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/6dd4f497-4c32-412e-906a-d5f84380dee6.json","externalId":"","uuid":"6dd4f497-4c32-412e-906a-d5f84380dee6","files":[]}
+{"parent":"288189b4-5618-4616-9a86-8209c52bfa78","pid":5547,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670976826988,"ppid":5513,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/3a20cbf5-03a8-4e28-9134-bcbe4e3999da.json","externalId":"","uuid":"3a20cbf5-03a8-4e28-9134-bcbe4e3999da","files":[]}

package/.nyc_output/processinfo/{bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0.json → 440df8ed-01d8-4b4a-86a4-141986b1c583.json}

@@ -1 +1 @@
-{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","pid":5595,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907491816,"ppid":5578,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0.json","externalId":"","uuid":"bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0","files":[]}
+{"parent":"288189b4-5618-4616-9a86-8209c52bfa78","pid":5530,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670976826639,"ppid":5513,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/440df8ed-01d8-4b4a-86a4-141986b1c583.json","externalId":"","uuid":"440df8ed-01d8-4b4a-86a4-141986b1c583","files":[]}

package/.nyc_output/processinfo/{bc6fd14e-b803-4750-ac28-dfe4b8d1c235.json → df2bb669-e900-4e87-9cf0-f9673bdda2d5.json}

@@ -1 +1 @@
-{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","pid":5589,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907491810,"ppid":5578,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/bc6fd14e-b803-4750-ac28-dfe4b8d1c235.json","externalId":"","uuid":"bc6fd14e-b803-4750-ac28-dfe4b8d1c235","files":[]}
+{"parent":"288189b4-5618-4616-9a86-8209c52bfa78","pid":5546,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670976826985,"ppid":5513,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/df2bb669-e900-4e87-9cf0-f9673bdda2d5.json","externalId":"","uuid":"df2bb669-e900-4e87-9cf0-f9673bdda2d5","files":[]}

package/.nyc_output/processinfo/index.json

@@ -1 +1 @@
-{"processes":{"4266a04d-f79f-4e25-82b5-a5503aad4653":{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","children":[]},"5a2007e8-1bda-4eda-b271-6d7323d49bdd":{"parent":null,"children":["4266a04d-f79f-4e25-82b5-a5503aad4653","6dd4f497-4c32-412e-906a-d5f84380dee6","bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0","bc6fd14e-b803-4750-ac28-dfe4b8d1c235"]},"6dd4f497-4c32-412e-906a-d5f84380dee6":{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","children":[]},"bc1d4fe0-2b67-4190-bcd2-9fd06daf74c0":{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","children":[]},"bc6fd14e-b803-4750-ac28-dfe4b8d1c235":{"parent":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","children":[]}},"files":{},"externalIds":{}}
+{"processes":{"0d71b778-7933-4ad7-b3a3-a0ab8fb25087":{"parent":"288189b4-5618-4616-9a86-8209c52bfa78","children":[]},"288189b4-5618-4616-9a86-8209c52bfa78":{"parent":null,"children":["0d71b778-7933-4ad7-b3a3-a0ab8fb25087","3a20cbf5-03a8-4e28-9134-bcbe4e3999da","440df8ed-01d8-4b4a-86a4-141986b1c583","df2bb669-e900-4e87-9cf0-f9673bdda2d5"]},"3a20cbf5-03a8-4e28-9134-bcbe4e3999da":{"parent":"288189b4-5618-4616-9a86-8209c52bfa78","children":[]},"440df8ed-01d8-4b4a-86a4-141986b1c583":{"parent":"288189b4-5618-4616-9a86-8209c52bfa78","children":[]},"df2bb669-e900-4e87-9cf0-f9673bdda2d5":{"parent":"288189b4-5618-4616-9a86-8209c52bfa78","children":[]}},"files":{},"externalIds":{}}

package/lib/translateTextTemplate.js

@@ -2,6 +2,8 @@ import { Tokenizer } from 'liquidjs';
 
 // Homebrewed pretty-regex writer
 const tokens = {
+    ENTER_COMMENT: `\\*/}}`,
+    EXIT_COMMENT: `{{/\\*`,
     END: `{{ end }}`,
     BEGIN: `{{ (if)`,
     BEGIN_SCOPED: `{{ (range|with|define|block|template)`,
@@ -11,6 +13,7 @@ const tokens = {
     REASSIGN: `{{ (\\$\\S+)  =  () }}`,
     WITH: `{{ with  () }}`,
     BOOKSHOP: `{{ partial  "bookshop"  \\( slice "()" () \\) }}`,
+    BOOKSHOP_VAR: `{{ partial  "bookshop"  \\( slice (\\S+) () \\) }}`,
     BOOKSHOP_SCOPED: `{{ partial  "bookshop"  \\(? \\. \\)? }}`,
 }
 
@@ -26,30 +29,42 @@ Object.entries(tokens).forEach(([name, r]) => {
  * that we already have in the bundle.
  * All go templating tags will come through as value tokens.
  */
-const rewriteTag = function (token, src, endTags, liveMarkup) {
+const rewriteTag = function (token, src, state, liveMarkup) {
     let raw = token.getText();
     let outputToken = {
         text: raw
     }
 
+    if (TOKENS.ENTER_COMMENT.test(raw)) {
+        state.inComment = true
+    }
+    if (TOKENS.EXIT_COMMENT.test(raw)) {
+        state.inComment = false
+        return outputToken;
+    }
+    if (state.inComment) {
+        return outputToken;
+    }
     // Skip non-value tags
     if (token.kind !== 8) return outputToken;
+
     if (TOKENS.END.test(raw)) {
-        endTags.push(outputToken);
+        state.endTags.push(outputToken);
         return outputToken;
     }
 
     if (TOKENS.BEGIN.test(raw)) {
-        endTags.pop();
+        state.endTags.pop();
     }
 
     if (TOKENS.BEGIN_SCOPED.test(raw)) {
         outputToken.text = `${outputToken.text}{{ \`<!--bookshop-live stack-->\` | safeHTML }}`;
 
-        let matchingEnd = endTags.pop();
+        let matchingEnd = state.endTags.pop();
         matchingEnd.text = `{{ \`<!--bookshop-live unstack-->\` | safeHTML }}${matchingEnd.text}`;
     }
 
+
     if (liveMarkup && TOKENS.INDEX_LOOP.test(raw)) {
         let [, index_variable, iterator] = raw.match(TOKENS.INDEX_LOOP);
         const r = required_wrapper_hugo_func(iterator);
@@ -89,6 +104,10 @@ const rewriteTag = function (token, src, endTags, liveMarkup) {
             `${outputToken.text}`,
             `{{ \`<!--bookshop-live end-->\` | safeHTML }}`
         ].join('');
+    } else if (liveMarkup && TOKENS.BOOKSHOP_VAR.test(raw)) {
+        let [, variable, params] = raw.match(TOKENS.BOOKSHOP_VAR);
+        const r = required_wrapper_hugo_func(params);
+        outputToken.text = `{{${r[0]} (printf \`<!--bookshop-live name(%s) params(.: (${tidy(params)}))-->\`${r[1]} (${variable})) | safeHTML }}${outputToken.text}{{ \`<!--bookshop-live end-->\` | safeHTML }}`
     }
 
     return outputToken;
@@ -111,10 +130,13 @@ export default function (text, opts) {
     const tokenizer = new Tokenizer(text.toString());
     const tokens = tokenizer.readTopLevelTokens();
     const output = [];
-    const endTags = [];
+    const state = {
+        endTags: [],
+        inComment: false
+    };
 
     tokens.reverse().forEach(tag => {
-        output.unshift(rewriteTag(tag, text, endTags, opts.liveMarkup));
+        output.unshift(rewriteTag(tag, text, state, opts.liveMarkup));
     });
 
     return output.map(t => t.text).join('');

package/lib/translateTextTemplate.test.js

@@ -11,6 +11,16 @@ test("add live markup to bookshop tags", t => {
     t.is(translateTextTemplate(input, {}), expected);
 });
 
+test("add live markup to bookshop tags referencing variables", t => {
+    const input = `{{ partial "bookshop" (slice .item._bookshop_name .item.something )}}`;
+    const expected = [
+        `{{ (printf \`<!--bookshop-live name(%s) params(.: (.item.something))-->\` (.item._bookshop_name)) | safeHTML }}`,
+        `{{ partial "bookshop" (slice .item._bookshop_name .item.something )}}`,
+        `{{ \`<!--bookshop-live end-->\` | safeHTML }}`
+    ].join('');
+    t.is(translateTextTemplate(input, {}), expected);
+});
+
 test("add live markup to scoped bookshop tags", t => {
     const input = `{{ partial "bookshop" . }}`;
     const expected = [
@@ -30,8 +40,18 @@ test("don't add live markup to bookshop_partial tags", t => {
 
 test("don't add live markup if no bookshop found", t => {
     let input = `{{ $a := .b }}`;
-    let expected = `{{ $a := .b }}`;
-    t.is(translateTextTemplate(input, {}), expected);
+    t.is(translateTextTemplate(input, {}), input);
+});
+
+test("don't add live markup to commented out regions", t => {
+    const input = [
+        `{{/* comment start <div>`,
+        ` . {{ partial "bookshop" (slice "content" (dict "content_html" .Params.note_html "type" "note")) }}`,
+        ` <h1> Hello World </h1>`,
+        ` . {{ partial "bookshop" . }}`,
+        `</div> comment end */}}`
+    ].join('\n');
+    t.is(translateTextTemplate(input, {}), input);
 });
 
 test("add live markup to assigns", t => {
@@ -175,4 +195,35 @@ test("add live markup to complex components", t => {
     {{ safeHTML $close }}
 {{ \`<!--bookshop-live unstack-->\` | safeHTML }}{{ end }}`;
     t.is(translateTextTemplate(input, {}), expected);
-});
+});
+
+// test("add live markup to another complex component", t => {
+//     const input = `
+// {{ if site.Params.env_bookshop_live }}
+
+// {{ partial "bookshop" (slice "layout_options" (slice (partial "bookshop" (slice "filtered_posts/component" .)) .)) }} 
+
+// {{ else }}
+// {{ $content := partial "bookshop" (slice "filtered_posts/component" .) }}
+// {{ $content = $content | strings.ReplaceRE \`<!--.*?-->\` "" | strings.ReplaceRE \`^\s+(.*?)\s+$\` "$1" | safeHTML }}
+
+// {{ if $content }}
+//     {{ partial "bookshop" (slice "layout_options" (slice $content .)) }} 
+// {{ end }}
+// {{ end }}`;
+//     const expected = `
+// {{ if site.Params.env_bookshop_live }}
+
+// {{ partial "bookshop" (slice "layout_options" (slice (partial "bookshop" (slice "filtered_posts/component" .)) .)) }} 
+
+// {{ else }}
+// {{ $content := partial "bookshop" (slice "filtered_posts/component" .) }}
+// {{ $content = $content | strings.ReplaceRE \`<!--.*?-->\` "" | strings.ReplaceRE \`^\s+(.*?)\s+$\` "$1" | safeHTML }}
+
+// {{ if $content }}
+//     {{ partial "bookshop" (slice "layout_options" (slice $content .)) }} 
+// {{ end }}
+// {{ end }}`;
+// console.log(translateTextTemplate(input, {}))
+//     t.is(translateTextTemplate(input, {}), expected);
+// });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bookshop/hugo-engine",
   "packageManager": "yarn@3.0.0",
-  "version": "3.4.0-beta.1",
+  "version": "3.4.0-beta.2",
   "description": "Bookshop frontend Hugo renderer",
   "type": "module",
   "sideEffects": false,
@@ -30,7 +30,7 @@
     "nyc": "^15.1.0"
   },
   "dependencies": {
-    "@bookshop/helpers": "3.4.0-beta.1",
+    "@bookshop/helpers": "3.4.0-beta.2",
     "esbuild": "^0.13.10",
     "fflate": "^0.7.3",
     "liquidjs": "9.28.0"

package/.nyc_output/processinfo/5a2007e8-1bda-4eda-b271-6d7323d49bdd.json

@@ -1 +0,0 @@
-{"parent":null,"pid":5578,"argv":["/opt/hostedtoolcache/node/16.18.1/x64/bin/node","/home/runner/work/bookshop/bookshop/javascript-modules/node_modules/ava/cli.js","-v"],"execArgv":[],"cwd":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine","time":1670907491400,"ppid":5566,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/5a2007e8-1bda-4eda-b271-6d7323d49bdd.json","externalId":"","uuid":"5a2007e8-1bda-4eda-b271-6d7323d49bdd","files":[]}