@glimmer/syntax
Version:
126 lines (105 loc) • 11.3 kB
JavaScript
import { isKeyword } from './keywords';
import { preprocess } from './parser/tokenizer-event-handlers';
import traverse from './traversal/traverse';
/**
* Gets the correct Token from the Node based on it's type
*/
function tokensFromType(node, scopedTokens, options) {
if (node.type === 'PathExpression') {
if (node.head.type === 'AtHead' || node.head.type === 'ThisHead') {
return;
}
const possbleToken = node.head.name;
if (scopedTokens.indexOf(possbleToken) === -1) {
return possbleToken;
}
} else if (node.type === 'ElementNode') {
const {
tag
} = node;
const char = tag.charAt(0);
if (char === ':' || char === '@') {
return;
}
if (!options.includeHtmlElements && tag.indexOf('.') === -1 && tag.toLowerCase() === tag) {
return;
}
if (tag.substr(0, 5) === 'this.') {
return;
}
if (scopedTokens.indexOf(tag) !== -1) {
return;
}
return tag;
}
}
/**
* Adds tokens to the tokensSet based on their node.type
*/
function addTokens(tokensSet, node, scopedTokens, options) {
const maybeTokens = tokensFromType(node, scopedTokens, options);
(Array.isArray(maybeTokens) ? maybeTokens : [maybeTokens]).forEach(maybeToken => {
if (maybeToken !== undefined && maybeToken[0] !== '@') {
const maybeTokenFirstSegment = maybeToken.split('.')[0];
if (!scopedTokens.includes(maybeTokenFirstSegment)) {
tokensSet.add(maybeToken.split('.')[0]);
}
}
});
}
/**
* Parses and traverses a given handlebars html template to extract all template locals
* referenced that could possible come from the parent scope. Can exclude known keywords
* optionally.
*/
export function getTemplateLocals(html, options = {
includeHtmlElements: false,
includeKeywords: false
}) {
const ast = preprocess(html);
const tokensSet = new Set();
const scopedTokens = [];
traverse(ast, {
Block: {
enter({
blockParams
}) {
blockParams.forEach(param => {
scopedTokens.push(param);
});
},
exit({
blockParams
}) {
blockParams.forEach(() => {
scopedTokens.pop();
});
}
},
ElementNode: {
enter(node) {
node.blockParams.forEach(param => {
scopedTokens.push(param);
});
addTokens(tokensSet, node, scopedTokens, options);
},
exit({
blockParams
}) {
blockParams.forEach(() => {
scopedTokens.pop();
});
}
},
PathExpression(node) {
addTokens(tokensSet, node, scopedTokens, options);
}
});
let tokens = [];
tokensSet.forEach(s => tokens.push(s));
if (!(options === null || options === void 0 ? void 0 : options.includeKeywords)) {
tokens = tokens.filter(token => !isKeyword(token));
}
return tokens;
}
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["../../../../packages/@glimmer/syntax/lib/get-template-locals.ts"],"names":[],"mappings":"AAAA,SAAS,SAAT,QAA0B,YAA1B;AACA,SAAS,UAAT,QAA2B,mCAA3B;AACA,OAAO,QAAP,MAAqB,sBAArB;AAQA;;;;AAGA,SAAS,cAAT,CACE,IADF,EAEE,YAFF,EAGE,OAHF,EAGmC;AAEjC,MAAI,IAAI,CAAC,IAAL,KAAc,gBAAlB,EAAoC;AAClC,QAAI,IAAI,CAAC,IAAL,CAAU,IAAV,KAAmB,QAAnB,IAA+B,IAAI,CAAC,IAAL,CAAU,IAAV,KAAmB,UAAtD,EAAkE;AAChE;AACD;;AAED,UAAM,YAAY,GAAG,IAAI,CAAC,IAAL,CAAU,IAA/B;;AAEA,QAAI,YAAY,CAAC,OAAb,CAAqB,YAArB,MAAuC,CAAC,CAA5C,EAA+C;AAC7C,aAAO,YAAP;AACD;AACF,GAVD,MAUO,IAAI,IAAI,CAAC,IAAL,KAAc,aAAlB,EAAiC;AACtC,UAAM;AAAE,MAAA;AAAF,QAAU,IAAhB;AAEA,UAAM,IAAI,GAAG,GAAG,CAAC,MAAJ,CAAW,CAAX,CAAb;;AAEA,QAAI,IAAI,KAAK,GAAT,IAAgB,IAAI,KAAK,GAA7B,EAAkC;AAChC;AACD;;AAED,QAAI,CAAC,OAAO,CAAC,mBAAT,IAAgC,GAAG,CAAC,OAAJ,CAAY,GAAZ,MAAqB,CAAC,CAAtD,IAA2D,GAAG,CAAC,WAAJ,OAAsB,GAArF,EAA0F;AACxF;AACD;;AAED,QAAI,GAAG,CAAC,MAAJ,CAAW,CAAX,EAAc,CAAd,MAAqB,OAAzB,EAAkC;AAChC;AACD;;AAED,QAAI,YAAY,CAAC,OAAb,CAAqB,GAArB,MAA8B,CAAC,CAAnC,EAAsC;AACpC;AACD;;AAED,WAAO,GAAP;AACD;AACF;AAED;;;;;AAGA,SAAS,SAAT,CACE,SADF,EAEE,IAFF,EAGE,YAHF,EAIE,OAJF,EAImC;AAEjC,QAAM,WAAW,GAAG,cAAc,CAAC,IAAD,EAAO,YAAP,EAAqB,OAArB,CAAlC;AAEA,GAAC,KAAK,CAAC,OAAN,CAAc,WAAd,IAA6B,WAA7B,GAA2C,CAAC,WAAD,CAA5C,EAA2D,OAA3D,CAAoE,UAAD,IAAe;AAChF,QAAI,UAAU,KAAK,SAAf,IAA4B,UAAU,CAAC,CAAD,CAAV,KAAkB,GAAlD,EAAuD;AACrD,YAAM,sBAAsB,GAAG,UAAU,CAAC,KAAX,CAAiB,GAAjB,EAAsB,CAAtB,CAA/B;;AACA,UAAI,CAAC,YAAY,CAAC,QAAb,CAAsB,sBAAtB,CAAL,EAAoD;AAClD,QAAA,SAAS,CAAC,GAAV,CAAc,UAAU,CAAC,KAAX,CAAiB,GAAjB,EAAsB,CAAtB,CAAd;AACD;AACF;AACF,GAPD;AAQD;AAED;;;;;;;AAKA,OAAM,SAAU,iBAAV,CACJ,IADI,EAEJ,OAAA,GAAoC;AAClC,EAAA,mBAAmB,EAAE,KADa;AAElC,EAAA,eAAe,EAAE;AAFiB,CAFhC,EAKH;AAED,QAAM,GAAG,GAAG,UAAU,CAAC,IAAD,CAAtB;AACA,QAAM,SAAS,GAAG,IAAI,GAAJ,EAAlB;AACA,QAAM,YAAY,GAAa,EAA/B;AAEA,EAAA,QAAQ,CAAC,GAAD,EAAM;AACZ,IAAA,KAAK,EAAE;AACL,MAAA,KAAK,CAAC;AAAE,QAAA;AAAF,OAAD,EAAgB;AACnB,QAAA,WAAW,CAAC,OAAZ,CAAqB,KAAD,IAAU;AAC5B,UAAA,YAAY,CAAC,IAAb,CAAkB,KAAlB;AACD,SAFD;AAGD,OALI;;AAOL,MAAA,IAAI,CAAC;AAAE,QAAA;AAAF,OAAD,EAAgB;AAClB,QAAA,WAAW,CAAC,OAAZ,CAAoB,MAAK;AACvB,UAAA,YAAY,CAAC,GAAb;AACD,SAFD;AAGD;;AAXI,KADK;AAeZ,IAAA,WAAW,EAAE;AACX,MAAA,KAAK,CAAC,IAAD,EAAK;AACR,QAAA,IAAI,CAAC,WAAL,CAAiB,OAAjB,CAA0B,KAAD,IAAU;AACjC,UAAA,YAAY,CAAC,IAAb,CAAkB,KAAlB;AACD,SAFD;AAGA,QAAA,SAAS,CAAC,SAAD,EAAY,IAAZ,EAAkB,YAAlB,EAAgC,OAAhC,CAAT;AACD,OANU;;AAQX,MAAA,IAAI,CAAC;AAAE,QAAA;AAAF,OAAD,EAAgB;AAClB,QAAA,WAAW,CAAC,OAAZ,CAAoB,MAAK;AACvB,UAAA,YAAY,CAAC,GAAb;AACD,SAFD;AAGD;;AAZU,KAfD;;AA8BZ,IAAA,cAAc,CAAC,IAAD,EAAK;AACjB,MAAA,SAAS,CAAC,SAAD,EAAY,IAAZ,EAAkB,YAAlB,EAAgC,OAAhC,CAAT;AACD;;AAhCW,GAAN,CAAR;AAmCA,MAAI,MAAM,GAAa,EAAvB;AAEA,EAAA,SAAS,CAAC,OAAV,CAAmB,CAAD,IAAO,MAAM,CAAC,IAAP,CAAY,CAAZ,CAAzB;;AAEA,MAAI,EAAC,OAAO,KAAA,IAAP,IAAA,OAAO,KAAA,KAAA,CAAP,GAAO,KAAA,CAAP,GAAA,OAAO,CAAE,eAAV,CAAJ,EAA+B;AAC7B,IAAA,MAAM,GAAG,MAAM,CAAC,MAAP,CAAe,KAAD,IAAW,CAAC,SAAS,CAAC,KAAD,CAAnC,CAAT;AACD;;AAED,SAAO,MAAP;AACD","sourcesContent":["import { isKeyword } from './keywords';\nimport { preprocess } from './parser/tokenizer-event-handlers';\nimport traverse from './traversal/traverse';\nimport * as ASTv1 from './v1/api';\n\ninterface GetTemplateLocalsOptions {\n  includeKeywords?: boolean;\n  includeHtmlElements?: boolean;\n}\n\n/**\n * Gets the correct Token from the Node based on it's type\n */\nfunction tokensFromType(\n  node: ASTv1.Node,\n  scopedTokens: string[],\n  options: GetTemplateLocalsOptions\n): string | void {\n  if (node.type === 'PathExpression') {\n    if (node.head.type === 'AtHead' || node.head.type === 'ThisHead') {\n      return;\n    }\n\n    const possbleToken = node.head.name;\n\n    if (scopedTokens.indexOf(possbleToken) === -1) {\n      return possbleToken;\n    }\n  } else if (node.type === 'ElementNode') {\n    const { tag } = node;\n\n    const char = tag.charAt(0);\n\n    if (char === ':' || char === '@') {\n      return;\n    }\n\n    if (!options.includeHtmlElements && tag.indexOf('.') === -1 && tag.toLowerCase() === tag) {\n      return;\n    }\n\n    if (tag.substr(0, 5) === 'this.') {\n      return;\n    }\n\n    if (scopedTokens.indexOf(tag) !== -1) {\n      return;\n    }\n\n    return tag;\n  }\n}\n\n/**\n * Adds tokens to the tokensSet based on their node.type\n */\nfunction addTokens(\n  tokensSet: Set<string>,\n  node: ASTv1.Node,\n  scopedTokens: string[],\n  options: GetTemplateLocalsOptions\n) {\n  const maybeTokens = tokensFromType(node, scopedTokens, options);\n\n  (Array.isArray(maybeTokens) ? maybeTokens : [maybeTokens]).forEach((maybeToken) => {\n    if (maybeToken !== undefined && maybeToken[0] !== '@') {\n      const maybeTokenFirstSegment = maybeToken.split('.')[0];\n      if (!scopedTokens.includes(maybeTokenFirstSegment)) {\n        tokensSet.add(maybeToken.split('.')[0]);\n      }\n    }\n  });\n}\n\n/**\n * Parses and traverses a given handlebars html template to extract all template locals\n * referenced that could possible come from the parent scope. Can exclude known keywords\n * optionally.\n */\nexport function getTemplateLocals(\n  html: string,\n  options: GetTemplateLocalsOptions = {\n    includeHtmlElements: false,\n    includeKeywords: false,\n  }\n): string[] {\n  const ast = preprocess(html);\n  const tokensSet = new Set<string>();\n  const scopedTokens: string[] = [];\n\n  traverse(ast, {\n    Block: {\n      enter({ blockParams }) {\n        blockParams.forEach((param) => {\n          scopedTokens.push(param);\n        });\n      },\n\n      exit({ blockParams }) {\n        blockParams.forEach(() => {\n          scopedTokens.pop();\n        });\n      },\n    },\n\n    ElementNode: {\n      enter(node) {\n        node.blockParams.forEach((param) => {\n          scopedTokens.push(param);\n        });\n        addTokens(tokensSet, node, scopedTokens, options);\n      },\n\n      exit({ blockParams }) {\n        blockParams.forEach(() => {\n          scopedTokens.pop();\n        });\n      },\n    },\n\n    PathExpression(node) {\n      addTokens(tokensSet, node, scopedTokens, options);\n    },\n  });\n\n  let tokens: string[] = [];\n\n  tokensSet.forEach((s) => tokens.push(s));\n\n  if (!options?.includeKeywords) {\n    tokens = tokens.filter((token) => !isKeyword(token));\n  }\n\n  return tokens;\n}\n"],"sourceRoot":""}