如何从Handlebars模板中提取所有被引用的partials
从Handlebars模板中提取所有引用Partials的实现方案
原生Handlebars编译生成的模板函数默认不会主动暴露引用的partial列表,我们可以通过扩展内置编译逻辑的方式实现你期望的挂载提取效果,全程不需要额外引入第三方解析库。
核心实现逻辑
我们不需要手动写正则匹配模板字符串里的{{> partialName}}写法(这种方式很容易误匹配注释、字符串内容里的符号),直接复用Handlebars内置的AST解析能力,遍历模板语法树收集所有partial调用节点即可:
const Handlebars = require('handlebars'); // 重写内置compile方法,自动为编译结果挂载partials属性 const nativeCompile = Handlebars.compile; Handlebars.compile = function(tplSource, compileOptions = {}) { const compiledTpl = nativeCompile.call(this, tplSource, compileOptions); const partialSet = new Set(); // 解析模板为语法树 const tplAst = Handlebars.parse(tplSource); // 递归遍历语法树收集所有partial调用 const traverseNodes = (nodeList) => { if (!nodeList?.length) return; nodeList.forEach(node => { // 匹配静态名称的partial调用 if (node.type === 'PartialStatement' && node.name.original) { partialSet.add(node.name.original); } // 递归遍历块级作用域下的子节点,收集嵌套在块内的partial引用 if (node.program) traverseNodes(node.program.body); if (node.inverse) traverseNodes(node.inverse.body); }) } traverseNodes(tplAst.body); // 将收集到的partial列表挂载到编译后的模板对象上 compiledTpl.partials = Array.from(partialSet); return compiledTpl; }
效果验证
按照给出的测试用例运行即可得到预期输出:
var template = Handlebars.compile('<p>Hello {{> mypartial}}</p>'); console.log(template.partials); // 输出 ['mypartial']
额外说明
- 该实现可以自动识别嵌套在块级语法(比如
{{#each}}、{{#if}})内的partial引用,不会遗漏 - 基于AST解析的方式可以正确过滤掉模板注释、字符串文本里的类partial写法,不会出现误匹配
- 如果需要兼容动态名称的partial(比如
{{> (getPartialName)}}),可以在节点判断逻辑里增加对应类型的收集规则即可。
内容的提问来源于stack exchange,提问作者damjuve
相关产品推荐
相关产品推荐

