@handlebars/parser 2.1.0 → 2.2.0

package/lib/whitespace-control.js

@@ -1,11 +1,11 @@
-import Visitor from './visitor';
+import Visitor from './visitor.js';
 
 function WhitespaceControl(options = {}) {
   this.options = options;
 }
 WhitespaceControl.prototype = new Visitor();
 
-WhitespaceControl.prototype.Program = function(program) {
+WhitespaceControl.prototype.Program = function (program) {
   const doStandalone = !this.options.ignoreStandalone;
 
   let isRoot = !this.isRootSeen;
@@ -62,88 +62,87 @@ WhitespaceControl.prototype.Program = function(program) {
   return program;
 };
 
-WhitespaceControl.prototype.BlockStatement = WhitespaceControl.prototype.DecoratorBlock = WhitespaceControl.prototype.PartialBlockStatement = function(
-  block
-) {
-  this.accept(block.program);
-  this.accept(block.inverse);
-
-  // Find the inverse program that is involed with whitespace stripping.
-  let program = block.program || block.inverse,
-    inverse = block.program && block.inverse,
-    firstInverse = inverse,
-    lastInverse = inverse;
-
-  if (inverse && inverse.chained) {
-    firstInverse = inverse.body[0].program;
-
-    // Walk the inverse chain to find the last inverse that is actually in the chain.
-    while (lastInverse.chained) {
-      lastInverse = lastInverse.body[lastInverse.body.length - 1].program;
-    }
-  }
+WhitespaceControl.prototype.BlockStatement =
+  WhitespaceControl.prototype.DecoratorBlock =
+  WhitespaceControl.prototype.PartialBlockStatement =
+    function (block) {
+      this.accept(block.program);
+      this.accept(block.inverse);
+
+      // Find the inverse program that is involved with whitespace stripping.
+      let program = block.program || block.inverse,
+        inverse = block.program && block.inverse,
+        firstInverse = inverse,
+        lastInverse = inverse;
+
+      if (inverse && inverse.chained) {
+        firstInverse = inverse.body[0].program;
+
+        // Walk the inverse chain to find the last inverse that is actually in the chain.
+        while (lastInverse.chained) {
+          lastInverse = lastInverse.body[lastInverse.body.length - 1].program;
+        }
+      }
 
-  let strip = {
-    open: block.openStrip.open,
-    close: block.closeStrip.close,
+      let strip = {
+        open: block.openStrip.open,
+        close: block.closeStrip.close,
 
-    // Determine the standalone candiacy. Basically flag our content as being possibly standalone
-    // so our parent can determine if we actually are standalone
-    openStandalone: isNextWhitespace(program.body),
-    closeStandalone: isPrevWhitespace((firstInverse || program).body)
-  };
+        // Determine the standalone candidacy. Basically flag our content as being possibly standalone
+        // so our parent can determine if we actually are standalone
+        openStandalone: isNextWhitespace(program.body),
+        closeStandalone: isPrevWhitespace((firstInverse || program).body),
+      };
 
-  if (block.openStrip.close) {
-    omitRight(program.body, null, true);
-  }
+      if (block.openStrip.close) {
+        omitRight(program.body, null, true);
+      }
 
-  if (inverse) {
-    let inverseStrip = block.inverseStrip;
+      if (inverse) {
+        let inverseStrip = block.inverseStrip;
 
-    if (inverseStrip.open) {
-      omitLeft(program.body, null, true);
-    }
+        if (inverseStrip.open) {
+          omitLeft(program.body, null, true);
+        }
 
-    if (inverseStrip.close) {
-      omitRight(firstInverse.body, null, true);
-    }
-    if (block.closeStrip.open) {
-      omitLeft(lastInverse.body, null, true);
-    }
+        if (inverseStrip.close) {
+          omitRight(firstInverse.body, null, true);
+        }
+        if (block.closeStrip.open) {
+          omitLeft(lastInverse.body, null, true);
+        }
 
-    // Find standalone else statments
-    if (
-      !this.options.ignoreStandalone &&
-      isPrevWhitespace(program.body) &&
-      isNextWhitespace(firstInverse.body)
-    ) {
-      omitLeft(program.body);
-      omitRight(firstInverse.body);
-    }
-  } else if (block.closeStrip.open) {
-    omitLeft(program.body, null, true);
-  }
+        // Find standalone else statements
+        if (
+          !this.options.ignoreStandalone &&
+          isPrevWhitespace(program.body) &&
+          isNextWhitespace(firstInverse.body)
+        ) {
+          omitLeft(program.body);
+          omitRight(firstInverse.body);
+        }
+      } else if (block.closeStrip.open) {
+        omitLeft(program.body, null, true);
+      }
 
-  return strip;
-};
+      return strip;
+    };
 
-WhitespaceControl.prototype.Decorator = WhitespaceControl.prototype.MustacheStatement = function(
-  mustache
-) {
-  return mustache.strip;
-};
+WhitespaceControl.prototype.Decorator =
+  WhitespaceControl.prototype.MustacheStatement = function (mustache) {
+    return mustache.strip;
+  };
 
-WhitespaceControl.prototype.PartialStatement = WhitespaceControl.prototype.CommentStatement = function(
-  node
-) {
-  /* istanbul ignore next */
-  let strip = node.strip || {};
-  return {
-    inlineStandalone: true,
-    open: strip.open,
-    close: strip.close
+WhitespaceControl.prototype.PartialStatement =
+  WhitespaceControl.prototype.CommentStatement = function (node) {
+    /* istanbul ignore next */
+    let strip = node.strip || {};
+    return {
+      inlineStandalone: true,
+      open: strip.open,
+      close: strip.close,
+    };
   };
-};
 
 function isPrevWhitespace(body, i, isRoot) {
   if (i === undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@handlebars/parser",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "The parser for the Handlebars language",
   "homepage": "https://github.com/handlebars-lang/handlebars-parser#readme",
   "bugs": {
@@ -12,56 +12,61 @@
   },
   "license": "ISC",
   "author": "",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "import": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "default": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "types/index.d.ts",
-  "scripts": {
-    "lint": "eslint .",
-    "prepublishOnly": "npm run build",
-    "build": "npm-run-all build:parser build:esm build:cjs",
-    "build:cjs": "tsc --module commonjs --target es5 --outDir dist/cjs",
-    "build:esm": "tsc --module es2015 --target es5 --outDir dist/esm",
-    "build:jison": "jison -m js src/handlebars.yy src/handlebars.l -o lib/parser.js",
-    "build:parser": "npm-run-all build:jison build:parser-suffix",
-    "build:parser-suffix": "combine-files lib/parser.js,src/parser-suffix.js lib/parser.js",
-    "test": "npm run build && mocha spec --require esm"
-  },
   "prettier": {
-    "tabWidth": 2,
     "semi": true,
-    "singleQuote": true
+    "singleQuote": true,
+    "tabWidth": 2
   },
   "devDependencies": {
     "combine-files": "^1.1.8",
-    "eslint": "^7.8.1",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-compat": "^3.8.0",
-    "esm": "^3.2.25",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^8.10.0",
+    "eslint-plugin-compat": "^6.0.1",
     "jison": "^0.4.18",
-    "mocha": "^8.1.3",
+    "mocha": "^10.7.3",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.1.1",
-    "release-it": "^14.0.2",
-    "release-it-lerna-changelog": "^2.4.0",
-    "typescript": "^4.0.2"
+    "release-plan": "^0.16.0",
+    "typescript": "^5.6.3"
+  },
+  "engines": {
+    "node": "^20.18.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "release-it": {
-    "plugins": {
-      "release-it-lerna-changelog": {
-        "infile": "CHANGELOG.md",
-        "launchEditor": true
-      }
-    },
-    "git": {
-      "tagName": "v${version}"
-    },
-    "github": {
-      "release": true,
-      "tokenRef": "GITHUB_AUTH"
-    }
+  "scripts": {
+    "lint": "eslint .",
+    "build": "npm-run-all build:parser build:esm build:cjs",
+    "build:cjs": "tsc --module nodenext --moduleResolution nodenext --target es5 --outDir dist/cjs",
+    "build:esm": "tsc --module es2015 --target es5 --outDir dist/esm",
+    "build:jison": "jison -m js src/handlebars.yy src/handlebars.l -o lib/parser.js",
+    "build:parser": "npm-run-all build:jison build:parser-suffix",
+    "build:parser-suffix": "combine-files lib/parser.js,src/parser-suffix.js lib/parser.js",
+    "pretest": "pnpm run build",
+    "test": "mocha --inline-diffs spec",
+    "pretest:bail": "pnpm run build",
+    "test:bail": "mocha --bail --inline-diffs spec"
   }
-}
+}

package/spec/{.eslintrc.js → .eslintrc.cjs}

@@ -1,5 +1,5 @@
 module.exports = {
-  extends: ['../.eslintrc.js'],
+  extends: ['../.eslintrc.cjs'],
   env: {
     mocha: true,
   },

package/spec/ast.js

@@ -1,17 +1,17 @@
-import { parse, parseWithoutProcessing } from '../dist/esm';
-import { equals } from './utils';
+import { parse, parseWithoutProcessing } from '../dist/esm/index.js';
+import { equals } from './utils.js';
 
-describe('ast', function() {
-  describe('whitespace control', function() {
-    describe('parse', function() {
-      it('mustache', function() {
+describe('ast', function () {
+  describe('whitespace control', function () {
+    describe('parse', function () {
+      it('mustache', function () {
         let ast = parse('  {{~comment~}} ');
 
         equals(ast.body[0].value, '');
         equals(ast.body[2].value, '');
       });
 
-      it('block statements', function() {
+      it('block statements', function () {
         let ast = parse(' {{# comment~}} \nfoo\n {{~/comment}}');
 
         equals(ast.body[0].value, '');
@@ -19,15 +19,15 @@ describe('ast', function() {
       });
     });
 
-    describe('parseWithoutProcessing', function() {
-      it('mustache', function() {
+    describe('parseWithoutProcessing', function () {
+      it('mustache', function () {
         let ast = parseWithoutProcessing('  {{~comment~}} ');
 
         equals(ast.body[0].value, '  ');
         equals(ast.body[2].value, ' ');
       });
 
-      it('block statements', function() {
+      it('block statements', function () {
         let ast = parseWithoutProcessing(
           ' {{# comment~}} \nfoo\n {{~/comment}}'
         );
@@ -38,16 +38,68 @@ describe('ast', function() {
     });
   });
 
-  describe('standalone flags', function() {
-    describe('mustache', function() {
-      it('does not mark mustaches as standalone', function() {
+  describe('node details', function () {
+    describe('paths', function () {
+      it('{{this}}', function () {
+        let path = parse('{{this}}').body[0].path;
+        equals(path.original, 'this');
+        equals(path.head, undefined);
+        equals(path.tail.length, 0);
+        equals(path.parts.length, 0);
+      });
+
+      it('{{this.bar}}', function () {
+        let path = parse('{{this.bar}}').body[0].path;
+        equals(path.original, 'this.bar');
+        equals(path.head, 'bar');
+        equals(path.tail.length, 0);
+        equals(path.parts.length, 1);
+        equals(path.parts[0], 'bar');
+      });
+
+      it('{{this.#bar}}', function () {
+        let path = parse('{{this.#bar}}').body[0].path;
+        equals(path.original, 'this.#bar');
+        equals(path.head, '#bar');
+        equals(path.tail.length, 0);
+        equals(path.parts.length, 1);
+        equals(path.parts[0], '#bar');
+      });
+
+      it('{{foo.bar}}', function () {
+        let path = parse('{{foo.bar}}').body[0].path;
+        equals(path.original, 'foo.bar');
+        equals(path.head, 'foo');
+        equals(path.tail.length, 1);
+        equals(path.tail[0], 'bar');
+        equals(path.parts.length, 2);
+        equals(path.parts[0], 'foo');
+        equals(path.parts[1], 'bar');
+      });
+
+      it('{{foo.#bar}}', function () {
+        let path = parse('{{foo.#bar}}').body[0].path;
+        equals(path.original, 'foo.#bar');
+        equals(path.head, 'foo');
+        equals(path.tail.length, 1);
+        equals(path.tail[0], '#bar');
+        equals(path.parts.length, 2);
+        equals(path.parts[0], 'foo');
+        equals(path.parts[1], '#bar');
+      });
+    });
+  });
+
+  describe('standalone flags', function () {
+    describe('mustache', function () {
+      it('does not mark mustaches as standalone', function () {
         let ast = parse('  {{comment}} ');
         equals(!!ast.body[0].value, true);
         equals(!!ast.body[2].value, true);
       });
     });
-    describe('blocks - parseWithoutProcessing', function() {
-      it('block mustaches', function() {
+    describe('blocks - parseWithoutProcessing', function () {
+      it('block mustaches', function () {
         let ast = parseWithoutProcessing(
             ' {{# comment}} \nfoo\n {{else}} \n  bar \n  {{/comment}} '
           ),
@@ -60,15 +112,13 @@ describe('ast', function() {
 
         equals(ast.body[2].value, ' ');
       });
-      it('initial block mustaches', function() {
-        let ast = parseWithoutProcessing(
-            '{{# comment}} \nfoo\n {{/comment}}'
-          ),
+      it('initial block mustaches', function () {
+        let ast = parseWithoutProcessing('{{# comment}} \nfoo\n {{/comment}}'),
           block = ast.body[0];
 
         equals(block.program.body[0].value, ' \nfoo\n ');
       });
-      it('mustaches with children', function() {
+      it('mustaches with children', function () {
         let ast = parseWithoutProcessing(
             '{{# comment}} \n{{foo}}\n {{/comment}}'
           ),
@@ -78,7 +128,7 @@ describe('ast', function() {
         equals(block.program.body[1].path.original, 'foo');
         equals(block.program.body[2].value, '\n ');
       });
-      it('nested block mustaches', function() {
+      it('nested block mustaches', function () {
         let ast = parseWithoutProcessing(
             '{{#foo}} \n{{# comment}} \nfoo\n {{else}} \n  bar \n  {{/comment}} \n{{/foo}}'
           ),
@@ -90,7 +140,7 @@ describe('ast', function() {
         equals(block.program.body[0].value, ' \nfoo\n ');
         equals(block.inverse.body[0].value, ' \n  bar \n  ');
       });
-      it('column 0 block mustaches', function() {
+      it('column 0 block mustaches', function () {
         let ast = parseWithoutProcessing(
             'test\n{{# comment}} \nfoo\n {{else}} \n  bar \n  {{/comment}} '
           ),
@@ -104,8 +154,8 @@ describe('ast', function() {
         equals(ast.body[2].value, ' ');
       });
     });
-    describe('blocks', function() {
-      it('marks block mustaches as standalone', function() {
+    describe('blocks', function () {
+      it('marks block mustaches as standalone', function () {
         let ast = parse(
             ' {{# comment}} \nfoo\n {{else}} \n  bar \n  {{/comment}} '
           ),
@@ -118,13 +168,13 @@ describe('ast', function() {
 
         equals(ast.body[2].value, '');
       });
-      it('marks initial block mustaches as standalone', function() {
+      it('marks initial block mustaches as standalone', function () {
         let ast = parse('{{# comment}} \nfoo\n {{/comment}}'),
           block = ast.body[0];
 
         equals(block.program.body[0].value, 'foo\n');
       });
-      it('marks mustaches with children as standalone', function() {
+      it('marks mustaches with children as standalone', function () {
         let ast = parse('{{# comment}} \n{{foo}}\n {{/comment}}'),
           block = ast.body[0];
 
@@ -132,7 +182,7 @@ describe('ast', function() {
         equals(block.program.body[1].path.original, 'foo');
         equals(block.program.body[2].value, '\n');
       });
-      it('marks nested block mustaches as standalone', function() {
+      it('marks nested block mustaches as standalone', function () {
         let ast = parse(
             '{{#foo}} \n{{# comment}} \nfoo\n {{else}} \n  bar \n  {{/comment}} \n{{/foo}}'
           ),
@@ -146,7 +196,7 @@ describe('ast', function() {
 
         equals(body[0].value, '');
       });
-      it('does not mark nested block mustaches as standalone', function() {
+      it('does not mark nested block mustaches as standalone', function () {
         let ast = parse(
             '{{#foo}} {{# comment}} \nfoo\n {{else}} \n  bar \n  {{/comment}} {{/foo}}'
           ),
@@ -160,7 +210,7 @@ describe('ast', function() {
 
         equals(body[0].omit, undefined);
       });
-      it('does not mark nested initial block mustaches as standalone', function() {
+      it('does not mark nested initial block mustaches as standalone', function () {
         let ast = parse(
             '{{#foo}}{{# comment}} \nfoo\n {{else}} \n  bar \n  {{/comment}}{{/foo}}'
           ),
@@ -173,7 +223,7 @@ describe('ast', function() {
         equals(body[0].omit, undefined);
       });
 
-      it('marks column 0 block mustaches as standalone', function() {
+      it('marks column 0 block mustaches as standalone', function () {
         let ast = parse(
             'test\n{{# comment}} \nfoo\n {{else}} \n  bar \n  {{/comment}} '
           ),
@@ -187,30 +237,30 @@ describe('ast', function() {
         equals(ast.body[2].value, '');
       });
     });
-    describe('partials - parseWithoutProcessing', function() {
-      it('simple partial', function() {
+    describe('partials - parseWithoutProcessing', function () {
+      it('simple partial', function () {
         let ast = parseWithoutProcessing('{{> partial }} ');
         equals(ast.body[1].value, ' ');
       });
-      it('indented partial', function() {
+      it('indented partial', function () {
         let ast = parseWithoutProcessing('  {{> partial }} ');
         equals(ast.body[0].value, '  ');
         equals(ast.body[1].indent, '');
         equals(ast.body[2].value, ' ');
       });
     });
-    describe('partials', function() {
-      it('marks partial as standalone', function() {
+    describe('partials', function () {
+      it('marks partial as standalone', function () {
         let ast = parse('{{> partial }} ');
         equals(ast.body[1].value, '');
       });
-      it('marks indented partial as standalone', function() {
+      it('marks indented partial as standalone', function () {
         let ast = parse('  {{> partial }} ');
         equals(ast.body[0].value, '');
         equals(ast.body[1].indent, '  ');
         equals(ast.body[2].value, '');
       });
-      it('marks those around content as not standalone', function() {
+      it('marks those around content as not standalone', function () {
         let ast = parse('a{{> partial }}');
         equals(ast.body[0].omit, undefined);
 
@@ -218,28 +268,28 @@ describe('ast', function() {
         equals(ast.body[1].omit, undefined);
       });
     });
-    describe('comments - parseWithoutProcessing', function() {
-      it('simple comment', function() {
+    describe('comments - parseWithoutProcessing', function () {
+      it('simple comment', function () {
         let ast = parseWithoutProcessing('{{! comment }} ');
         equals(ast.body[1].value, ' ');
       });
-      it('indented comment', function() {
+      it('indented comment', function () {
         let ast = parseWithoutProcessing('  {{! comment }} ');
         equals(ast.body[0].value, '  ');
         equals(ast.body[2].value, ' ');
       });
     });
-    describe('comments', function() {
-      it('marks comment as standalone', function() {
+    describe('comments', function () {
+      it('marks comment as standalone', function () {
         let ast = parse('{{! comment }} ');
         equals(ast.body[1].value, '');
       });
-      it('marks indented comment as standalone', function() {
+      it('marks indented comment as standalone', function () {
         let ast = parse('  {{! comment }} ');
         equals(ast.body[0].value, '');
         equals(ast.body[2].value, '');
       });
-      it('marks those around content as not standalone', function() {
+      it('marks those around content as not standalone', function () {
         let ast = parse('a{{! comment }}');
         equals(ast.body[0].omit, undefined);