@bookshop/hugo-engine 2.4.0-hugo.0 → 2.4.0-hugo.1

package/.npmrc

@@ -0,0 +1 @@
+engine-strict = true

package/.nyc_output/processinfo/0aba92b1-ff4b-4ce1-95dc-4c9309743616.json

@@ -0,0 +1 @@
+{"parent":null,"pid":58164,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/cli.js","-v"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643508567891,"ppid":58151,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/0aba92b1-ff4b-4ce1-95dc-4c9309743616.json","externalId":"","uuid":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","files":[]}

package/.nyc_output/processinfo/{50eb2ebd-c797-4d3f-8df7-a707c1b211eb.json → 1c730ea9-4f60-42cc-aeb9-b7ab9ffe808d.json}

@@ -1 +1 @@
-{"parent":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","pid":88151,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643327931802,"ppid":88149,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/50eb2ebd-c797-4d3f-8df7-a707c1b211eb.json","externalId":"","uuid":"50eb2ebd-c797-4d3f-8df7-a707c1b211eb","files":[]}
+{"parent":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","pid":58166,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643508568414,"ppid":58164,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/1c730ea9-4f60-42cc-aeb9-b7ab9ffe808d.json","externalId":"","uuid":"1c730ea9-4f60-42cc-aeb9-b7ab9ffe808d","files":[]}

package/.nyc_output/processinfo/{86f85916-4f58-43da-8c32-c1ec29ca783e.json → 39623a8d-3884-4bd8-9bb3-d34b0adbe309.json}

@@ -1 +1 @@
-{"parent":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","pid":88152,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643327931805,"ppid":88149,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/86f85916-4f58-43da-8c32-c1ec29ca783e.json","externalId":"","uuid":"86f85916-4f58-43da-8c32-c1ec29ca783e","files":[]}
+{"parent":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","pid":58165,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643508568407,"ppid":58164,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/39623a8d-3884-4bd8-9bb3-d34b0adbe309.json","externalId":"","uuid":"39623a8d-3884-4bd8-9bb3-d34b0adbe309","files":[]}

package/.nyc_output/processinfo/{a27680c8-8858-4ede-921d-6e6617f42a0b.json → 813da5a0-42e1-4fc2-85bc-09abb19c8211.json}

@@ -1 +1 @@
-{"parent":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","pid":88150,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643327931794,"ppid":88149,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/a27680c8-8858-4ede-921d-6e6617f42a0b.json","externalId":"","uuid":"a27680c8-8858-4ede-921d-6e6617f42a0b","files":[]}
+{"parent":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","pid":58168,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643508568423,"ppid":58164,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/813da5a0-42e1-4fc2-85bc-09abb19c8211.json","externalId":"","uuid":"813da5a0-42e1-4fc2-85bc-09abb19c8211","files":[]}

package/.nyc_output/processinfo/{ecca87c1-5774-4962-864a-2e4537aa9915.json → afe35238-e9ea-4a4c-9aae-2b8d52b2d2f9.json}

@@ -1 +1 @@
-{"parent":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","pid":88153,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643327931809,"ppid":88149,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/ecca87c1-5774-4962-864a-2e4537aa9915.json","externalId":"","uuid":"ecca87c1-5774-4962-864a-2e4537aa9915","files":[]}
+{"parent":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","pid":58167,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/lib/worker/subprocess.js"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643508568419,"ppid":58164,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/afe35238-e9ea-4a4c-9aae-2b8d52b2d2f9.json","externalId":"","uuid":"afe35238-e9ea-4a4c-9aae-2b8d52b2d2f9","files":[]}

package/.nyc_output/processinfo/index.json

@@ -1 +1 @@
-{"processes":{"50eb2ebd-c797-4d3f-8df7-a707c1b211eb":{"parent":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","children":[]},"86f85916-4f58-43da-8c32-c1ec29ca783e":{"parent":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","children":[]},"a27680c8-8858-4ede-921d-6e6617f42a0b":{"parent":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","children":[]},"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe":{"parent":null,"children":["50eb2ebd-c797-4d3f-8df7-a707c1b211eb","86f85916-4f58-43da-8c32-c1ec29ca783e","a27680c8-8858-4ede-921d-6e6617f42a0b","ecca87c1-5774-4962-864a-2e4537aa9915"]},"ecca87c1-5774-4962-864a-2e4537aa9915":{"parent":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","children":[]}},"files":{},"externalIds":{}}
+{"processes":{"0aba92b1-ff4b-4ce1-95dc-4c9309743616":{"parent":null,"children":["1c730ea9-4f60-42cc-aeb9-b7ab9ffe808d","39623a8d-3884-4bd8-9bb3-d34b0adbe309","813da5a0-42e1-4fc2-85bc-09abb19c8211","afe35238-e9ea-4a4c-9aae-2b8d52b2d2f9"]},"1c730ea9-4f60-42cc-aeb9-b7ab9ffe808d":{"parent":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","children":[]},"39623a8d-3884-4bd8-9bb3-d34b0adbe309":{"parent":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","children":[]},"813da5a0-42e1-4fc2-85bc-09abb19c8211":{"parent":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","children":[]},"afe35238-e9ea-4a4c-9aae-2b8d52b2d2f9":{"parent":"0aba92b1-ff4b-4ce1-95dc-4c9309743616","children":[]}},"files":{},"externalIds":{}}

package/hugo-renderer/tpl/bookshop_engine/bookshop_render.go

@@ -38,10 +38,10 @@ func createFuncMap(d *deps.Deps) map[string]interface{} {
 // as well as a JSON blob of its data,
 // and renders it.
 func RenderHugo(templateString string, props string) interface{} {
-	var parsedProps map[string]interface{}
+	var parsedProps interface{}
 	err := json.Unmarshal([]byte(props), &parsedProps)
 	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("bad json unmarshal: %s", err.Error()))
+		buf := bytes.NewBufferString(fmt.Sprintf("BKSHERR: bad json unmarshal: %s", err.Error()))
 		return buf.String()
 	}
 
@@ -50,14 +50,14 @@ func RenderHugo(templateString string, props string) interface{} {
 
 	templ, err := template.New("").Funcs(funcMap).Parse(templateString)
 	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("bad template parse: %s", err.Error()))
+		buf := bytes.NewBufferString(fmt.Sprintf("BKSHERR: bad template parse: %s", err.Error()))
 		return buf.String()
 	}
 
 	buf := bytes.NewBufferString("")
 	err = templ.Execute(buf, parsedProps)
 	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("bad template render: %s", err.Error()))
+		buf := bytes.NewBufferString(fmt.Sprintf("BKSHERR: bad template render: %s", err.Error()))
 		return buf.String()
 	}
 	return buf.String()

package/lib/engine.js

@@ -94,13 +94,20 @@ export class Engine {
         source = translateTextTemplate(source, {});
         if (!globals || typeof globals !== "object") globals = {};
         props = { ...globals, ...props };
+
+        // If we have assigned a root scope we need to pass that in as the context
+        if (props["."]) props = props["."];
         const output = window.renderHugo(source, JSON.stringify(props));
-        target.innerHTML = output;
+        if (/BKSHERR/.test(output)) {
+            console.error(output);
+        } else {
+            target.innerHTML = output;
+        }
     }
 
     async eval(str, props = [{}]) {
         while (!window.renderHugo) await sleep(10);
-        const props_obj = props.reduce((a, b) => { return { ...b, ...a } });
+        let props_obj = props.reduce((a, b) => { return { ...b, ...a } });
 
         // We're capable of looking up a simple variable
         // (and it's hard to pass to wasm since we store variables on the context)
@@ -108,6 +115,9 @@ export class Engine {
             return props_obj[str] ?? null;
         }
 
+        // If we have assigned a root scope we need to pass that in as the context
+        if (props_obj["."]) props_obj = props_obj["."];
+
         // Rewrite array.0 into index array 0
         str = str.replace(/(.*)\.(\d+)$/, (_, obj, index) => {
             return `index (${obj}) ${index}`;

package/lib/translateTextTemplate.js

@@ -2,8 +2,11 @@ import { Tokenizer } from 'liquidjs';
 
 const tokens = {
     END: /{{\s*end\s*}}/,
+    BEGIN: /{{\s*(if)/,
+    BEGIN_SCOPED: /{{\s*(range|with|define|block|template)/,
     LOOP: /{{\s*range\s+(.+?)\s*}}/,
     ASSIGN: /{{\s*(\$\S+)\s+:=\s+(.+?)\s*}}/,
+    WITH: /{{\s*with\s+(.+?)\s*}}/,
     BOOKSHOP: /{{\s*partial\s+"bookshop(?:_partial)?"\s+\(\s*slice\s+"(.+?)" (.+?)\s*\)\s*}}/,
 }
 
@@ -12,33 +15,49 @@ const tokens = {
  * that we already have in the bundle.
  * All go templating tags will come through as value tokens.
  */
-const rewriteTag = function (token, src, liveMarkup) {
+const rewriteTag = function (token, src, endTags, liveMarkup) {
     let raw = token.getText();
+    let outputToken = {
+        text: raw
+    }
 
     // Skip non-value tags
-    if (token.kind !== 8) return src;
-    if (tokens.END.test(raw)) return src;
+    if (token.kind !== 8) return outputToken;
+    if (tokens.END.test(raw)) {
+        endTags.push(outputToken);
+        return outputToken;
+    }
+
+    if (tokens.BEGIN.test(raw)) {
+        endTags.pop();
+    }
+
+    if (tokens.BEGIN_SCOPED.test(raw)) {
+        outputToken.text = `${outputToken.text}{{ \`<!--bookshop-live stack-->\` | safeHTML }}`;
+
+        let matchingEnd = endTags.pop();
+        matchingEnd.text = `{{ \`<!--bookshop-live unstack-->\` | safeHTML }}${matchingEnd.text}`;
+    }
 
     if (liveMarkup && tokens.LOOP.test(raw)) {
         let [, iterator] = raw.match(tokens.LOOP);
-        raw = [`{{ $bookshop__live__iterator := 0 }}`,
-            `${raw}`,
+        outputToken.text = [`{{ $bookshop__live__iterator := 0 }}`,
+            `${outputToken.text}`,
             `{{ (printf \`<!--bookshop-live context(.: (index (${iterator}) %d))-->\` $bookshop__live__iterator) | safeHTML }}`,
             `{{ $bookshop__live__iterator = (add $bookshop__live__iterator 1) }}`
         ].join('')
     } else if (liveMarkup && tokens.ASSIGN.test(raw)) {
         let [, identifier, value] = raw.match(tokens.ASSIGN);
-        raw = `${raw}{{ \`<!--bookshop-live context(${identifier}: ${value})-->\` | safeHTML }}`
+        outputToken.text = `${outputToken.text}{{ \`<!--bookshop-live context(${identifier}: ${value})-->\` | safeHTML }}`
+    } else if (liveMarkup && tokens.WITH.test(raw)) {
+        let [, value] = raw.match(tokens.WITH);
+        outputToken.text = `${outputToken.text}{{ \`<!--bookshop-live context(.: ${value})-->\` | safeHTML }}`
     } else if (liveMarkup && tokens.BOOKSHOP.test(raw)) {
         let [, name, params] = raw.match(tokens.BOOKSHOP);
-        raw = `{{ \`<!--bookshop-live name(${name}) params(.: ${params})-->\` | safeHTML }}${raw}{{ \`<!--bookshop-live end-->\` | safeHTML }}`
+        outputToken.text = `{{ \`<!--bookshop-live name(${name}) params(.: ${params})-->\` | safeHTML }}${outputToken.text}{{ \`<!--bookshop-live end-->\` | safeHTML }}`
     }
 
-    return [
-        src.substr(0, token.begin),
-        raw,
-        src.substr(token.end)
-    ].join('');
+    return outputToken;
 }
 
 export default function (text, opts) {
@@ -46,13 +65,14 @@ export default function (text, opts) {
         liveMarkup: true,
         ...opts
     }
-    text = text.toString();
-    const tokenizer = new Tokenizer(text);
-    const output = tokenizer.readTopLevelTokens();
+    const tokenizer = new Tokenizer(text.toString());
+    const tokens = tokenizer.readTopLevelTokens();
+    const output = [];
+    const endTags = [];
 
-    output.reverse().forEach(tag => {
-        text = rewriteTag(tag, text, opts.liveMarkup);
+    tokens.reverse().forEach(tag => {
+        output.unshift(rewriteTag(tag, text, endTags, opts.liveMarkup));
     });
 
-    return text;
+    return output.map(t => t.text).join('');
 };

package/lib/translateTextTemplate.test.js

@@ -27,13 +27,64 @@ test("add live markup to assigns", t => {
     t.is(translateTextTemplate(input, {}), expected);
 });
 
+test("add live markup to withs", t => {
+    const input = `{{ with .b }}<p>{{.}}</p>{{ end }}`;
+    const expected = [`{{ with .b }}`,
+        `{{ \`<!--bookshop-live stack-->\` | safeHTML }}`,
+        `{{ \`<!--bookshop-live context(.: .b)-->\` | safeHTML }}`,
+        `<p>{{.}}</p>`,
+        `{{ \`<!--bookshop-live unstack-->\` | safeHTML }}`,
+        `{{ end }}`
+    ].join('');
+    t.is(translateTextTemplate(input, {}), expected);
+});
+
 test("add live markup to loops", t => {
     const input = `{{ range .items }}<p>{{ . }}</p>{{ end }}`;
     const expected = [`{{ $bookshop__live__iterator := 0 }}`,
         `{{ range .items }}`,
+        `{{ \`<!--bookshop-live stack-->\` | safeHTML }}`,
         `{{ (printf \`<!--bookshop-live context(.: (index (.items) %d))-->\` $bookshop__live__iterator) | safeHTML }}`,
         `{{ $bookshop__live__iterator = (add $bookshop__live__iterator 1) }}`,
-        `<p>{{ . }}</p>{{ end }}`
+        `<p>{{ . }}</p>`,
+        `{{ \`<!--bookshop-live unstack-->\` | safeHTML }}`,
+        `{{ end }}`
     ].join('');
     t.is(translateTextTemplate(input, {}), expected);
+});
+
+test("add live markup to complex end structures", t => {
+    const input = `
+{{ range .items }}
+
+    {{with .text}}
+    <p>{{ . }}</p>
+    {{ end }}
+
+    {{ if .subtitle }}
+        <h2>{{ .subtitle }}</h2>
+    {{ else }}
+        {{ with .excerpt }}
+        <p>{{ . }}</p>
+        {{end}}
+    {{ end }}
+
+{{ end }}`;
+    const expected = `
+{{ $bookshop__live__iterator := 0 }}{{ range .items }}{{ \`<!--bookshop-live stack-->\` | safeHTML }}{{ (printf \`<!--bookshop-live context(.: (index (.items) %d))-->\` $bookshop__live__iterator) | safeHTML }}{{ $bookshop__live__iterator = (add $bookshop__live__iterator 1) }}
+
+    {{with .text}}{{ \`<!--bookshop-live stack-->\` | safeHTML }}{{ \`<!--bookshop-live context(.: .text)-->\` | safeHTML }}
+    <p>{{ . }}</p>
+    {{ \`<!--bookshop-live unstack-->\` | safeHTML }}{{ end }}
+
+    {{ if .subtitle }}
+        <h2>{{ .subtitle }}</h2>
+    {{ else }}
+        {{ with .excerpt }}{{ \`<!--bookshop-live stack-->\` | safeHTML }}{{ \`<!--bookshop-live context(.: .excerpt)-->\` | safeHTML }}
+        <p>{{ . }}</p>
+        {{ \`<!--bookshop-live unstack-->\` | safeHTML }}{{end}}
+    {{ end }}
+
+{{ \`<!--bookshop-live unstack-->\` | safeHTML }}{{ end }}`;
+    t.is(translateTextTemplate(input, {}), expected);
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bookshop/hugo-engine",
   "packageManager": "yarn@3.0.0",
-  "version": "2.4.0-hugo.0",
+  "version": "2.4.0-hugo.1",
   "description": "Bookshop frontend Hugo renderer",
   "type": "module",
   "sideEffects": false,
@@ -10,6 +10,12 @@
     ".": "./main.js",
     "./build": "./build.js"
   },
+  "files": [
+    "*.js",
+    "lib/*.js",
+    "!**/*.test.js",
+    "hugo-renderer/hugo_renderer.wasm"
+  ],
   "scripts": {
     "test": "nyc ava -v"
   },
@@ -23,8 +29,9 @@
     "nyc": "^15.1.0"
   },
   "dependencies": {
-    "@bookshop/helpers": "2.4.0-hugo.0",
-    "esbuild": "^0.13.10"
+    "@bookshop/helpers": "2.4.0-hugo.1",
+    "esbuild": "^0.13.10",
+    "liquidjs": "9.28.0"
   },
   "engines": {
     "node": ">=14.16"

package/.nyc_output/processinfo/b5f86652-cbe8-44f9-a36c-d5721dfe5bbe.json

@@ -1 +0,0 @@
-{"parent":null,"pid":88149,"argv":["/Users/liambigelow/.nvm/versions/node/v14.16.0/bin/node","/Users/liambigelow/Projects/CC/bookshop/javascript-modules/node_modules/ava/cli.js","-v"],"execArgv":[],"cwd":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine","time":1643327931302,"ppid":88148,"coverageFilename":"/Users/liambigelow/Projects/CC/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/b5f86652-cbe8-44f9-a36c-d5721dfe5bbe.json","externalId":"","uuid":"b5f86652-cbe8-44f9-a36c-d5721dfe5bbe","files":[]}