Merge 83316c3 into 894afc4

lib/index.js

@@ -36,7 +36,7 @@
  * obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-import PartialCollector from './partial-collector.js'
+import collectPartials from './partials.js'
 import { createFilter } from '@rollup/pluginutils'
 import Handlebars from 'handlebars'
 
@@ -125,13 +125,11 @@ export default class PluginImpl {
     const ast = Handlebars.parse(code, opts)
     const compiled = Handlebars.precompile(ast, opts)
     const { code: tmpl = compiled, map: srcMap } = compiled
-    const collector = new PartialCollector()
-    collector.accept(ast)
 
     const beforeTmpl = [
       IMPORT_HANDLEBARS,
       IMPORT_HELPERS,
-      ...collector.partials.map(p => `import '${this.#partialPath(p, id)}'`),
+      ...collectPartials(ast).map(p => `import '${this.#partialPath(p, id)}'`),
       'export const RawTemplate = Handlebars.template('
     ]
     const afterTmpl = [

lib/partial-collector.js → lib/partials.js

@@ -42,7 +42,7 @@ import Handlebars from 'handlebars'
  * Collects the names of partial templates from a Handlebars template
  * @see https://github.com/handlebars-lang/handlebars.js/blob/master/docs/compiler-api.md
  */
-export default class PartialCollector extends Handlebars.Visitor {
+class PartialCollector extends Handlebars.Visitor {
   partials = []
 
   PartialStatement(partial) {
@@ -55,5 +55,23 @@ export default class PartialCollector extends Handlebars.Visitor {
     return super.PartialBlockStatement(partial)
   }
 
-  collect(n) { if (n.type === 'PathExpression') this.partials.push(n.original) }
+  collect(n) {
+    if (n.type === 'PathExpression' && n.original !== '@partial-block') {
+      this.partials.push(n.original)
+    }
+  }
+}
+
+/**
+ * Returns the partial names parsed from a Handlebars template
+ * @see https://handlebarsjs.com/guide/partials.html
+ * @see https://github.com/handlebars-lang/handlebars.js/blob/master/docs/compiler-api.md
+ * @param {object} ast - abstract syntax tree for a Handlebars template returned
+ *   by Handlebars.parse()
+ * @returns {string[]} - a list of partial names parsed from the template
+ */
+export default function collectPartials(ast) {
+  const collector = new PartialCollector()
+  collector.accept(ast)
+  return collector.partials
 }

test/main.test.js

@@ -4,9 +4,9 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-import { describe, expect, test } from 'vitest'
 import HandlebarsPrecompiler from '../index.js'
 import { PLUGIN_NAME } from '../lib/index.js'
+import { describe, expect, test } from 'vitest'
 
 const PLUGIN_ID = `\0${PLUGIN_NAME}`
 

test/partials.test.js

@@ -0,0 +1,74 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import collectPartials from '../lib/partials.js'
+import Handlebars from 'handlebars'
+import { describe, expect, test } from 'vitest'
+
+describe('collectPartials', () => {
+  /**
+   * Returns the partial names parsed from a Handlebars template
+   * @param {string} s - Handlebars template strin to parse
+   * @returns {string[]} - a list of partial names parsed from the template
+   */
+  const partials = (s) => collectPartials(Handlebars.parse(s, {}))
+
+  describe('parses', () => {
+    test('regular partials', () => {
+      const s = '{{ foo }}{{> bar }}{{ baz }}{{> quux }}{{ xyzzy }}{{> plugh }}'
+
+      expect(partials(s))
+        .toEqual(['bar', 'quux', 'plugh'])
+    })
+
+    test('partials with contexts or parameters', () => {
+      expect(partials('{{> foo bar}}{{> baz quux=xyzzy }}'))
+        .toEqual(['foo', 'baz'])
+    })
+
+    test('block partials', () => {
+      expect(partials('{{#> foo }}bar{{>baz}}quux{{/foo}}'))
+        .toEqual(['foo', 'baz'])
+    })
+  })
+
+  describe('ignores', () => {
+    test('dynamic partials', () => {
+      expect(partials('{{> foo }}{{> (lookup . ignored) }}{{> bar }}'))
+        .toEqual(['foo', 'bar'])
+    })
+
+    test('@partial-block', () => {
+      expect(partials('Some text {{> @partial-block }}'))
+        .toEqual([])
+    })
+
+    test('inline partials', () => {
+      // Examples from:
+      // - https://handlebarsjs.com/guide/partials.html#inline-partials
+      const s = [
+        '{{#*inline "myPartial"}}',
+        '  My Content',
+        '{{/inline}}',
+        '{{#each people}}',
+        '  {{> myPartial}}',
+        '{{/each}}',
+        '',
+        '{{#> layout}}',
+        '  {{#*inline "nav"}}',
+        '    My Nav',
+        '  {{/inline}}',
+        '  {{#*inline "content"}}',
+        '    My Content',
+        '  {{/inline}}',
+        '{{/layout}}'
+      ].join('\n')
+
+      expect(partials(s))
+        .toEqual(['myPartial', 'layout'])
+    })
+  })
+})