get-template-locals.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. import { isKeyword } from './keywords';
  2. import { preprocess } from './parser/tokenizer-event-handlers';
  3. import traverse from './traversal/traverse';
  4. /**
  5. * Gets the correct Token from the Node based on it's type
  6. */
  7. function tokensFromType(node, scopedTokens, options) {
  8. if (node.type === 'PathExpression') {
  9. if (node.head.type === 'AtHead' || node.head.type === 'ThisHead') {
  10. return;
  11. }
  12. var possbleToken = node.head.name;
  13. if (scopedTokens.indexOf(possbleToken) === -1) {
  14. return possbleToken;
  15. }
  16. } else if (node.type === 'ElementNode') {
  17. var tag = node.tag;
  18. var _char = tag.charAt(0);
  19. if (_char === ':' || _char === '@') {
  20. return;
  21. }
  22. if (!options.includeHtmlElements && tag.indexOf('.') === -1 && tag.toLowerCase() === tag) {
  23. return;
  24. }
  25. if (tag.substr(0, 5) === 'this.') {
  26. return;
  27. }
  28. if (scopedTokens.indexOf(tag) !== -1) {
  29. return;
  30. }
  31. return tag;
  32. }
  33. }
  34. /**
  35. * Adds tokens to the tokensSet based on their node.type
  36. */
  37. function addTokens(tokensSet, node, scopedTokens, options) {
  38. var maybeTokens = tokensFromType(node, scopedTokens, options);
  39. (Array.isArray(maybeTokens) ? maybeTokens : [maybeTokens]).forEach(function (maybeToken) {
  40. if (maybeToken !== undefined && maybeToken[0] !== '@') {
  41. tokensSet.add(maybeToken.split('.')[0]);
  42. }
  43. });
  44. }
  45. /**
  46. * Parses and traverses a given handlebars html template to extract all template locals
  47. * referenced that could possible come from the praent scope. Can exclude known keywords
  48. * optionally.
  49. */
  50. export function getTemplateLocals(html, options) {
  51. if (options === void 0) {
  52. options = {
  53. includeHtmlElements: false,
  54. includeKeywords: false
  55. };
  56. }
  57. var ast = preprocess(html);
  58. var tokensSet = new Set();
  59. var scopedTokens = [];
  60. traverse(ast, {
  61. Block: {
  62. enter: function enter(_ref) {
  63. var blockParams = _ref.blockParams;
  64. blockParams.forEach(function (param) {
  65. scopedTokens.push(param);
  66. });
  67. },
  68. exit: function exit(_ref2) {
  69. var blockParams = _ref2.blockParams;
  70. blockParams.forEach(function () {
  71. scopedTokens.pop();
  72. });
  73. }
  74. },
  75. ElementNode: {
  76. enter: function enter(node) {
  77. node.blockParams.forEach(function (param) {
  78. scopedTokens.push(param);
  79. });
  80. addTokens(tokensSet, node, scopedTokens, options);
  81. },
  82. exit: function exit(_ref3) {
  83. var blockParams = _ref3.blockParams;
  84. blockParams.forEach(function () {
  85. scopedTokens.pop();
  86. });
  87. }
  88. },
  89. PathExpression: function PathExpression(node) {
  90. addTokens(tokensSet, node, scopedTokens, options);
  91. }
  92. });
  93. var tokens = [];
  94. tokensSet.forEach(function (s) {
  95. return tokens.push(s);
  96. });
  97. if (!(options === null || options === void 0 ? void 0 : options.includeKeywords)) {
  98. tokens = tokens.filter(function (token) {
  99. return !isKeyword(token);
  100. });
  101. }
  102. return tokens;
  103. }
  104. //# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["../../../../packages/@glimmer/syntax/lib/get-template-locals.ts"],"names":[],"mappings":"AAAA,SAAA,SAAA,QAAA,YAAA;AACA,SAAA,UAAA,QAAA,mCAAA;AACA,OAAA,QAAA,MAAA,sBAAA;AAQA;;;;AAGA,SAAA,cAAA,CAAA,IAAA,EAAA,YAAA,EAAA,OAAA,EAGmC;AAEjC,MAAI,IAAI,CAAJ,IAAA,KAAJ,gBAAA,EAAoC;AAClC,QAAI,IAAI,CAAJ,IAAA,CAAA,IAAA,KAAA,QAAA,IAA+B,IAAI,CAAJ,IAAA,CAAA,IAAA,KAAnC,UAAA,EAAkE;AAChE;AACD;;AAED,QAAM,YAAY,GAAG,IAAI,CAAJ,IAAA,CAArB,IAAA;;AAEA,QAAI,YAAY,CAAZ,OAAA,CAAA,YAAA,MAAuC,CAA3C,CAAA,EAA+C;AAC7C,aAAA,YAAA;AACD;AATH,GAAA,MAUO,IAAI,IAAI,CAAJ,IAAA,KAAJ,aAAA,EAAiC;AAAA,QAC9B,GAD8B,GACtC,IADsC,CAC9B,GAD8B;;AAGtC,QAAM,KAAI,GAAG,GAAG,CAAH,MAAA,CAAb,CAAa,CAAb;;AAEA,QAAI,KAAI,KAAJ,GAAA,IAAgB,KAAI,KAAxB,GAAA,EAAkC;AAChC;AACD;;AAED,QAAI,CAAC,OAAO,CAAR,mBAAA,IAAgC,GAAG,CAAH,OAAA,CAAA,GAAA,MAAqB,CAArD,CAAA,IAA2D,GAAG,CAAH,WAAA,OAA/D,GAAA,EAA0F;AACxF;AACD;;AAED,QAAI,GAAG,CAAH,MAAA,CAAA,CAAA,EAAA,CAAA,MAAJ,OAAA,EAAkC;AAChC;AACD;;AAED,QAAI,YAAY,CAAZ,OAAA,CAAA,GAAA,MAA8B,CAAlC,CAAA,EAAsC;AACpC;AACD;;AAED,WAAA,GAAA;AACD;AACF;AAED;;;;;AAGA,SAAA,SAAA,CAAA,SAAA,EAAA,IAAA,EAAA,YAAA,EAAA,OAAA,EAImC;AAEjC,MAAM,WAAW,GAAG,cAAc,CAAA,IAAA,EAAA,YAAA,EAAlC,OAAkC,CAAlC;AAEA,GAAC,KAAK,CAAL,OAAA,CAAA,WAAA,IAAA,WAAA,GAA2C,CAA5C,WAA4C,CAA5C,EAAA,OAAA,CAAoE,UAAA,UAAD,EAAe;AAChF,QAAI,UAAU,KAAV,SAAA,IAA4B,UAAU,CAAV,CAAU,CAAV,KAAhC,GAAA,EAAuD;AACrD,MAAA,SAAS,CAAT,GAAA,CAAc,UAAU,CAAV,KAAA,CAAA,GAAA,EAAd,CAAc,CAAd;AACD;AAHH,GAAA;AAKD;AAED;;;;;;;AAKA,OAAM,SAAA,iBAAA,CAAA,IAAA,EAEJ,OAFI,EAKH;AAAA,MAHD,OAGC;AAHD,IAAA,OAGC,GAHmC;AAClC,MAAA,mBAAmB,EADe,KAAA;AAElC,MAAA,eAAe,EAAE;AAFiB,KAGnC;AAAA;;AAED,MAAM,GAAG,GAAG,UAAU,CAAtB,IAAsB,CAAtB;AACA,MAAM,SAAS,GAAG,IAAlB,GAAkB,EAAlB;AACA,MAAM,YAAY,GAAlB,EAAA;AAEA,EAAA,QAAQ,CAAA,GAAA,EAAM;AACZ,IAAA,KAAK,EAAE;AACL,MAAA,KADK,uBACgB;AAAA,YAAb,WAAa,QAAb,WAAa;AACnB,QAAA,WAAW,CAAX,OAAA,CAAqB,UAAA,KAAD,EAAU;AAC5B,UAAA,YAAY,CAAZ,IAAA,CAAA,KAAA;AADF,SAAA;AAFG,OAAA;AAOL,MAAA,IAPK,uBAOe;AAAA,YAAb,WAAa,SAAb,WAAa;AAClB,QAAA,WAAW,CAAX,OAAA,CAAoB,YAAK;AACvB,UAAA,YAAY,CAAZ,GAAA;AADF,SAAA;AAGD;AAXI,KADK;AAeZ,IAAA,WAAW,EAAE;AACX,MAAA,KADW,iBACN,IADM,EACD;AACR,QAAA,IAAI,CAAJ,WAAA,CAAA,OAAA,CAA0B,UAAA,KAAD,EAAU;AACjC,UAAA,YAAY,CAAZ,IAAA,CAAA,KAAA;AADF,SAAA;AAGA,QAAA,SAAS,CAAA,SAAA,EAAA,IAAA,EAAA,YAAA,EAAT,OAAS,CAAT;AALS,OAAA;AAQX,MAAA,IARW,uBAQS;AAAA,YAAb,WAAa,SAAb,WAAa;AAClB,QAAA,WAAW,CAAX,OAAA,CAAoB,YAAK;AACvB,UAAA,YAAY,CAAZ,GAAA;AADF,SAAA;AAGD;AAZU,KAfD;AA8BZ,IAAA,cA9BY,0BA8BE,IA9BF,EA8BO;AACjB,MAAA,SAAS,CAAA,SAAA,EAAA,IAAA,EAAA,YAAA,EAAT,OAAS,CAAT;AACD;AAhCW,GAAN,CAAR;AAmCA,MAAI,MAAM,GAAV,EAAA;AAEA,EAAA,SAAS,CAAT,OAAA,CAAmB,UAAA,CAAD;AAAA,WAAO,MAAM,CAAN,IAAA,CAAzB,CAAyB,CAAP;AAAA,GAAlB;;AAEA,MAAI,EAAC,OAAO,KAAP,IAAA,IAAA,OAAO,KAAA,KAAP,CAAA,GAAO,KAAP,CAAA,GAAA,OAAO,CAAZ,eAAI,CAAJ,EAA+B;AAC7B,IAAA,MAAM,GAAG,MAAM,CAAN,MAAA,CAAe,UAAA,KAAD;AAAA,aAAW,CAAC,SAAS,CAA5C,KAA4C,CAArB;AAAA,KAAd,CAAT;AACD;;AAED,SAAA,MAAA;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      tokensSet.add(maybeToken.split('.')[0]);\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 praent 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":""}