@bookshop/hugo-engine 3.5.1 → 3.6.0-beta.1

package/.nyc_output/processinfo/{0576b405-4d6f-416a-a012-1cd6714d2de3.json → 96d19458-1b60-4859-b031-8c72da9099fa.json}

@@ -1 +1 @@
-{"parent":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","pid":5527,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1683882586943,"ppid":5494,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/0576b405-4d6f-416a-a012-1cd6714d2de3.json","externalId":"","uuid":"0576b405-4d6f-416a-a012-1cd6714d2de3","files":[]}
+{"parent":"aef2ad68-7f2b-4e6e-8583-9c924153a305","pid":5755,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1685414618193,"ppid":5714,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/96d19458-1b60-4859-b031-8c72da9099fa.json","externalId":"","uuid":"96d19458-1b60-4859-b031-8c72da9099fa","files":[]}

package/.nyc_output/processinfo/{1186c40f-ab1b-4fc3-8c8f-905478755bdd.json → a648c40e-de2c-4837-b1c6-3f187fd60093.json}

@@ -1 +1 @@
-{"parent":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","pid":5511,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1683882586504,"ppid":5494,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/1186c40f-ab1b-4fc3-8c8f-905478755bdd.json","externalId":"","uuid":"1186c40f-ab1b-4fc3-8c8f-905478755bdd","files":[]}
+{"parent":"aef2ad68-7f2b-4e6e-8583-9c924153a305","pid":5732,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1685414617697,"ppid":5714,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/a648c40e-de2c-4837-b1c6-3f187fd60093.json","externalId":"","uuid":"a648c40e-de2c-4837-b1c6-3f187fd60093","files":[]}

package/.nyc_output/processinfo/{9afa86b4-7892-4e9a-b022-45b2ba35af2a.json → a9c10755-e4bf-46a5-8e9f-c8198ddfc209.json}

@@ -1 +1 @@
-{"parent":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","pid":5505,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1683882586497,"ppid":5494,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/9afa86b4-7892-4e9a-b022-45b2ba35af2a.json","externalId":"","uuid":"9afa86b4-7892-4e9a-b022-45b2ba35af2a","files":[]}
+{"parent":"aef2ad68-7f2b-4e6e-8583-9c924153a305","pid":5748,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1685414618152,"ppid":5714,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/a9c10755-e4bf-46a5-8e9f-c8198ddfc209.json","externalId":"","uuid":"a9c10755-e4bf-46a5-8e9f-c8198ddfc209","files":[]}

package/.nyc_output/processinfo/aef2ad68-7f2b-4e6e-8583-9c924153a305.json

@@ -0,0 +1 @@
+{"parent":null,"pid":5714,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1685414617162,"ppid":5703,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/aef2ad68-7f2b-4e6e-8583-9c924153a305.json","externalId":"","uuid":"aef2ad68-7f2b-4e6e-8583-9c924153a305","files":[]}

package/.nyc_output/processinfo/{e261f702-c88f-4b27-aebb-f0ddcd3d512e.json → f950cb79-a99a-4f06-a217-fa041433aec7.json}

@@ -1 +1 @@
-{"parent":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","pid":5534,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1683882586987,"ppid":5494,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/e261f702-c88f-4b27-aebb-f0ddcd3d512e.json","externalId":"","uuid":"e261f702-c88f-4b27-aebb-f0ddcd3d512e","files":[]}
+{"parent":"aef2ad68-7f2b-4e6e-8583-9c924153a305","pid":5726,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1685414617687,"ppid":5714,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/f950cb79-a99a-4f06-a217-fa041433aec7.json","externalId":"","uuid":"f950cb79-a99a-4f06-a217-fa041433aec7","files":[]}

package/.nyc_output/processinfo/index.json

@@ -1 +1 @@
-{"processes":{"0576b405-4d6f-416a-a012-1cd6714d2de3":{"parent":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","children":[]},"1186c40f-ab1b-4fc3-8c8f-905478755bdd":{"parent":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","children":[]},"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538":{"parent":null,"children":["0576b405-4d6f-416a-a012-1cd6714d2de3","1186c40f-ab1b-4fc3-8c8f-905478755bdd","9afa86b4-7892-4e9a-b022-45b2ba35af2a","e261f702-c88f-4b27-aebb-f0ddcd3d512e"]},"9afa86b4-7892-4e9a-b022-45b2ba35af2a":{"parent":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","children":[]},"e261f702-c88f-4b27-aebb-f0ddcd3d512e":{"parent":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","children":[]}},"files":{},"externalIds":{}}
+{"processes":{"96d19458-1b60-4859-b031-8c72da9099fa":{"parent":"aef2ad68-7f2b-4e6e-8583-9c924153a305","children":[]},"a648c40e-de2c-4837-b1c6-3f187fd60093":{"parent":"aef2ad68-7f2b-4e6e-8583-9c924153a305","children":[]},"a9c10755-e4bf-46a5-8e9f-c8198ddfc209":{"parent":"aef2ad68-7f2b-4e6e-8583-9c924153a305","children":[]},"aef2ad68-7f2b-4e6e-8583-9c924153a305":{"parent":null,"children":["96d19458-1b60-4859-b031-8c72da9099fa","a648c40e-de2c-4837-b1c6-3f187fd60093","a9c10755-e4bf-46a5-8e9f-c8198ddfc209","f950cb79-a99a-4f06-a217-fa041433aec7"]},"f950cb79-a99a-4f06-a217-fa041433aec7":{"parent":"aef2ad68-7f2b-4e6e-8583-9c924153a305","children":[]}},"files":{},"externalIds":{}}

package/bookshop-hugo-templates/helpers/component.html

@@ -12,14 +12,23 @@
 {{- $component_name := index . 0 -}}
 {{- $component_props := index . 1 -}}
 {{- $component_path := partial "_bookshop/helpers/component_key" $component_name -}}
+{{- $flat_component_path := partial "_bookshop/helpers/flat_component_key" $component_name -}}
 
+{{- $resolved_component := false -}}
 {{- if templates.Exists ( printf "partials/%s" $component_path ) -}}
+    {{- $resolved_component = $component_path -}}
+{{- else if templates.Exists ( printf "partials/%s" $flat_component_path ) -}}
+    {{- $resolved_component = $flat_component_path -}}
+{{- end -}}
+
+{{- if $resolved_component -}}
 
 {{/* Suppress comments when live editing {{ (printf "<!--bookshop-live name(%s)-->" $component_name) | safeHTML }} */}}
-{{- partial $component_path $component_props -}}
+{{- partial $resolved_component $component_props -}}
 {{/* Suppress comments when live editing {{ "<!--bookshop-live end-->" | safeHTML }} */}}
 
 {{- else -}}
     {{- $file_loc := slicestr $component_path 9 -}}
-    {{- partial "_bookshop/errors/err" (printf "Component \"%s\" does not exist.\n     Create this component by placing a file in your bookshop at %s" $component_name $file_loc) -}}
+    {{- $flat_file_loc := slicestr $flat_component_path 9 -}}
+    {{- partial "_bookshop/errors/err" (printf "Component \"%s\" does not exist.\n     Create this component by placing a file in your bookshop at %s or %s" $component_name $file_loc $flat_file_loc) -}}
 {{- end -}}

package/bookshop-hugo-templates/helpers/flat_component_key.html

@@ -0,0 +1,9 @@
+{{/*
+    Converts a bare Bookshop component key to a flat Bookshop path
+    i.e. "a/b" --> "bookshop/components/a/b.hugo.html"
+
+    Expects a String.
+*/}}
+
+{{ $component_path := (printf "bookshop/components/%s.hugo.html" .) }}
+{{ return $component_path }}

package/lib/engine.js

@@ -58,6 +58,7 @@ export class Engine {
             "layouts/partials/bookshop_bindings.html": (await import("../bookshop-hugo-templates/bookshop_bindings.html")).default,
             "layouts/partials/_bookshop/helpers/component.html": (await import("../bookshop-hugo-templates/helpers/component.html")).default,
             "layouts/partials/_bookshop/helpers/component_key.html": (await import("../bookshop-hugo-templates/helpers/component_key.html")).default,
+            "layouts/partials/_bookshop/helpers/flat_component_key.html": (await import("../bookshop-hugo-templates/helpers/flat_component_key.html")).default,
             "layouts/partials/_bookshop/helpers/partial.html": (await import("../bookshop-hugo-templates/helpers/partial.html")).default,
             "layouts/partials/_bookshop/helpers/partial_key.html": (await import("../bookshop-hugo-templates/helpers/partial_key.html")).default,
             "layouts/partials/_bookshop/errors/bad_bookshop_tag.html": (await import("../bookshop-hugo-templates/errors/bad_bookshop_tag.html")).default,
@@ -156,14 +157,20 @@ export class Engine {
         return `components/${name}/${base}.hugo.html`;
     }
 
+    getFlatComponentKey(name) {
+        return `components/${name}.hugo.html`;
+    }
+
     getComponent(name) {
         const key = this.getComponentKey(name);
-        return this.files?.[key];
+        const flatKey = this.getFlatComponentKey(name);
+        return this.files?.[key] ?? this.files?.[flatKey];
     }
 
     hasComponent(name) {
         const key = this.getComponentKey(name);
-        return !!this.files?.[key];
+        const flatKey = this.getFlatComponentKey(name);
+        return !!(this.files?.[key] ?? this.files?.[flatKey]);
     }
 
     hasShared(name) {

package/lib/engine__test__.js

@@ -58,6 +58,7 @@ export class Engine {
             "layouts/partials/bookshop_bindings.html": (await import("../bookshop-hugo-templates/bookshop_bindings.html")).default,
             "layouts/partials/_bookshop/helpers/component.html": (await import("../bookshop-hugo-templates/helpers/component.html")).default,
             "layouts/partials/_bookshop/helpers/component_key.html": (await import("../bookshop-hugo-templates/helpers/component_key.html")).default,
+            "layouts/partials/_bookshop/helpers/flat_component_key.html": (await import("../bookshop-hugo-templates/helpers/flat_component_key.html")).default,
             "layouts/partials/_bookshop/helpers/partial.html": (await import("../bookshop-hugo-templates/helpers/partial.html")).default,
             "layouts/partials/_bookshop/helpers/partial_key.html": (await import("../bookshop-hugo-templates/helpers/partial_key.html")).default,
             "layouts/partials/_bookshop/errors/bad_bookshop_tag.html": (await import("../bookshop-hugo-templates/errors/bad_bookshop_tag.html")).default,
@@ -156,14 +157,20 @@ export class Engine {
         return `components/${name}/${base}.hugo.html`;
     }
 
+    getFlatComponentKey(name) {
+        return `components/${name}.hugo.html`;
+    }
+
     getComponent(name) {
         const key = this.getComponentKey(name);
-        return this.files?.[key];
+        const flatKey = this.getFlatComponentKey(name);
+        return this.files?.[key] ?? this.files?.[flatKey];
     }
 
     hasComponent(name) {
         const key = this.getComponentKey(name);
-        return !!this.files?.[key];
+        const flatKey = this.getFlatComponentKey(name);
+        return !!(this.files?.[key] ?? this.files?.[flatKey]);
     }
 
     hasShared(name) {

package/lib/translateTextTemplate.js

@@ -124,6 +124,10 @@ export default function (text, opts) {
         liveMarkup: true,
         ...opts
     }
+
+    // If this component contains no subcomponents,
+    // we don't need to add any special comments as there
+    // can be no data bindings within.
     if (!/bookshop/.test(text)) {
         return text;
     }

package/package.json

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

package/.nyc_output/processinfo/2fdbc94b-8ef1-4abe-8419-3b1f5ae13538.json

@@ -1 +0,0 @@
-{"parent":null,"pid":5494,"argv":["/opt/hostedtoolcache/node/16.20.0/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":1683882585987,"ppid":5483,"coverageFilename":"/home/runner/work/bookshop/bookshop/javascript-modules/engines/hugo-engine/.nyc_output/2fdbc94b-8ef1-4abe-8419-3b1f5ae13538.json","externalId":"","uuid":"2fdbc94b-8ef1-4abe-8419-3b1f5ae13538","files":[]}