htmljs-parser 5.5.1 → 5.5.2

package/dist/core/Parser.d.ts

@@ -1,4 +1,4 @@
-import { STATE, Range, ParserOptions as Options, ErrorCode } from "../internal";
+import { STATE, type Range, type ParserOptions as Options, ErrorCode } from "../internal";
 export interface Meta extends Range {
     parent: Meta;
     state: StateDefinition;

package/dist/index.js

@@ -136,6 +136,7 @@ function getPosAfterLine(lines, startLine, index) {
 
 // src/core/Parser.ts
 var Parser = class {
+  // Keeps track of line indexes to provide line/column info.
   constructor(options) {
     this.options = options;
   }
@@ -172,6 +173,9 @@ var Parser = class {
     activeState.exit.call(this, activeRange);
     this.activeState.return.call(this, activeRange, parent);
   }
+  /**
+   * Compare a position in the source to either another position, or a string.
+   */
   matchAtPos(a, b) {
     const aPos = a.start;
     const aLen = a.end - aPos;
@@ -201,6 +205,10 @@ var Parser = class {
     }
     return false;
   }
+  /**
+   * Look ahead to see if the given str matches the substring sequence
+   * beyond
+   */
   lookAheadFor(str, startPos = this.pos + 1) {
     let i = str.length;
     if (startPos + i <= this.maxPos) {
@@ -229,6 +237,12 @@ var Parser = class {
       this.textPos = -1;
     }
   }
+  /**
+   * This is used to enter into "HTML" parsing mode instead
+   * of concise HTML. We push a block on to the stack so that we know when
+   * return back to the previous parsing mode and to ensure that all
+   * tags within a block are properly closed.
+   */
   beginHtmlBlock(delimiter, singleLine) {
     var _a;
     const content = this.enterState(
@@ -265,6 +279,7 @@ var Parser = class {
       (_b = (_a = this.options).onCloseTagName) == null ? void 0 : _b.call(_a, name);
     (_d = (_c = this.options).onCloseTagEnd) == null ? void 0 : _d.call(_c, { start, end });
   }
+  // --------------------------
   consumeWhitespaceIfBefore(str, start = 0) {
     const { pos, data } = this;
     let cur = pos + start;
@@ -519,8 +534,8 @@ var OPEN_TAG = {
         }
         return;
       }
-      if (code === 45 /* HTML_BLOCK_DELIMITER */) {
-        if (this.lookAtCharCodeAhead(1) !== 45 /* HTML_BLOCK_DELIMITER */) {
+      if (code === 45 /* HYPHEN */) {
+        if (this.lookAtCharCodeAhead(1) !== 45 /* HYPHEN */) {
           this.emitError(
             tag,
             19 /* MALFORMED_OPEN_TAG */,
@@ -685,6 +700,7 @@ var OPEN_TAG = {
         }
         (_b = (_a = this.options).onTagVar) == null ? void 0 : _b.call(_a, {
           start: child.start - 1,
+          // include /,
           end: child.end,
           value: {
             start: child.start,
@@ -734,6 +750,7 @@ var OPEN_TAG = {
         const end = ++this.pos;
         const types = {
           start: child.start - 1,
+          // include <
           end,
           value: {
             start: child.start,
@@ -964,6 +981,7 @@ var ATTRIBUTE = {
           typeParams,
           body: {
             start: child.start - 1,
+            // include {
             end,
             value: {
               start: child.start,
@@ -1132,7 +1150,7 @@ var BEGIN_DELIMITED_HTML_BLOCK = {
   exit() {
   },
   char(code, block) {
-    if (code === 45 /* HTML_BLOCK_DELIMITER */) {
+    if (code === 45 /* HYPHEN */) {
       block.delimiter += "-";
     } else {
       const startPos = this.pos;
@@ -1215,7 +1233,9 @@ var CDATA = {
       end: cdata.end,
       value: {
         start: cdata.start + 9,
+        // strip <![CDATA[
         end: cdata.end - 3
+        // strip ]]>
       }
     });
   },
@@ -1388,7 +1408,7 @@ var CONCISE_HTML_CONTENT = {
         }
       }
       if (parentTag) {
-        if (parentTag.type === 1 /* text */ && code !== 45 /* HTML_BLOCK_DELIMITER */) {
+        if (parentTag.type === 1 /* text */ && code !== 45 /* HYPHEN */) {
           this.emitError(
             this.pos,
             8 /* INVALID_LINE_START */,
@@ -1420,8 +1440,8 @@ var CONCISE_HTML_CONTENT = {
             return;
           }
           break;
-        case 45 /* HTML_BLOCK_DELIMITER */:
-          if (this.lookAtCharCodeAhead(1) === 45 /* HTML_BLOCK_DELIMITER */) {
+        case 45 /* HYPHEN */:
+          if (this.lookAtCharCodeAhead(1) === 45 /* HYPHEN */) {
             this.enterState(states_exports.BEGIN_DELIMITED_HTML_BLOCK);
             this.pos--;
           } else {
@@ -1470,6 +1490,7 @@ var CONCISE_HTML_CONTENT = {
           end: child.end,
           value: {
             start: child.start + 2,
+            // strip //
             end: child.end
           }
         });
@@ -1480,7 +1501,9 @@ var CONCISE_HTML_CONTENT = {
           end: child.end,
           value: {
             start: child.start + 2,
+            // strip /*
             end: child.end - 2
+            // strip */,
           }
         });
         if (!this.consumeWhitespaceOnLine(0)) {
@@ -1540,7 +1563,9 @@ function exitDeclaration(parser, declaration, closeOffset) {
     end: declaration.end,
     value: {
       start: declaration.start + 2,
+      // strip <?
       end: declaration.end - closeOffset
+      // > or ?>
     }
   });
 }
@@ -1564,7 +1589,9 @@ var DTD = {
       end: documentType.end,
       value: {
         start: documentType.start + 2,
+        // strip <!
         end: documentType.end - 1
+        // strip >
       }
     });
   },
@@ -1972,7 +1999,9 @@ var HTML_COMMENT = {
       end: comment.end,
       value: {
         start: comment.start + 4,
+        // strip <!--
         end: comment.end - 3
+        // strip -->
       }
     });
   },
@@ -2098,6 +2127,7 @@ var HTML_CONTENT = {
           end: child.end,
           value: {
             start: child.start + 2,
+            // strip //
             end: child.end
           }
         });
@@ -2108,7 +2138,9 @@ var HTML_CONTENT = {
           end: child.end,
           value: {
             start: child.start + 2,
+            // strip /*
             end: child.end - 2
+            // strip */,
           }
         });
         break;
@@ -2331,7 +2363,9 @@ var PLACEHOLDER = {
       escape: placeholder.escape,
       value: {
         start: placeholder.start + (placeholder.escape ? 2 : 3),
+        // ignore ${ or $!{
         end: placeholder.end - 1
+        // ignore }
       }
     });
   },
@@ -2700,15 +2734,27 @@ var PARSED_STRING = {
 function createParser(handlers) {
   const parser = new Parser(handlers);
   return {
+    /**
+     * Parses code and calls the provided handlers.
+     */
     parse(code) {
       return parser.parse(code);
     },
+    /**
+     * Given an offset range in the current source code, reads and returns the substring in the input code.
+     */
     read(range) {
       return parser.read(range);
     },
+    /**
+     * Given a offset in the current source code, returns a Position object with line & character information.
+     */
     positionAt(offset) {
       return parser.positionAt(offset);
     },
+    /**
+     * Given a offset range in the current source code, returns a Location object with a start & end position information.
+     */
     locationAt(range) {
       return parser.locationAt(range);
     }

package/dist/index.mjs

@@ -111,6 +111,7 @@ function getPosAfterLine(lines, startLine, index) {
 
 // src/core/Parser.ts
 var Parser = class {
+  // Keeps track of line indexes to provide line/column info.
   constructor(options) {
     this.options = options;
   }
@@ -147,6 +148,9 @@ var Parser = class {
     activeState.exit.call(this, activeRange);
     this.activeState.return.call(this, activeRange, parent);
   }
+  /**
+   * Compare a position in the source to either another position, or a string.
+   */
   matchAtPos(a, b) {
     const aPos = a.start;
     const aLen = a.end - aPos;
@@ -176,6 +180,10 @@ var Parser = class {
     }
     return false;
   }
+  /**
+   * Look ahead to see if the given str matches the substring sequence
+   * beyond
+   */
   lookAheadFor(str, startPos = this.pos + 1) {
     let i = str.length;
     if (startPos + i <= this.maxPos) {
@@ -204,6 +212,12 @@ var Parser = class {
       this.textPos = -1;
     }
   }
+  /**
+   * This is used to enter into "HTML" parsing mode instead
+   * of concise HTML. We push a block on to the stack so that we know when
+   * return back to the previous parsing mode and to ensure that all
+   * tags within a block are properly closed.
+   */
   beginHtmlBlock(delimiter, singleLine) {
     var _a;
     const content = this.enterState(
@@ -240,6 +254,7 @@ var Parser = class {
       (_b = (_a = this.options).onCloseTagName) == null ? void 0 : _b.call(_a, name);
     (_d = (_c = this.options).onCloseTagEnd) == null ? void 0 : _d.call(_c, { start, end });
   }
+  // --------------------------
   consumeWhitespaceIfBefore(str, start = 0) {
     const { pos, data } = this;
     let cur = pos + start;
@@ -494,8 +509,8 @@ var OPEN_TAG = {
         }
         return;
       }
-      if (code === 45 /* HTML_BLOCK_DELIMITER */) {
-        if (this.lookAtCharCodeAhead(1) !== 45 /* HTML_BLOCK_DELIMITER */) {
+      if (code === 45 /* HYPHEN */) {
+        if (this.lookAtCharCodeAhead(1) !== 45 /* HYPHEN */) {
           this.emitError(
             tag,
             19 /* MALFORMED_OPEN_TAG */,
@@ -660,6 +675,7 @@ var OPEN_TAG = {
         }
         (_b = (_a = this.options).onTagVar) == null ? void 0 : _b.call(_a, {
           start: child.start - 1,
+          // include /,
           end: child.end,
           value: {
             start: child.start,
@@ -709,6 +725,7 @@ var OPEN_TAG = {
         const end = ++this.pos;
         const types = {
           start: child.start - 1,
+          // include <
           end,
           value: {
             start: child.start,
@@ -939,6 +956,7 @@ var ATTRIBUTE = {
           typeParams,
           body: {
             start: child.start - 1,
+            // include {
             end,
             value: {
               start: child.start,
@@ -1107,7 +1125,7 @@ var BEGIN_DELIMITED_HTML_BLOCK = {
   exit() {
   },
   char(code, block) {
-    if (code === 45 /* HTML_BLOCK_DELIMITER */) {
+    if (code === 45 /* HYPHEN */) {
       block.delimiter += "-";
     } else {
       const startPos = this.pos;
@@ -1190,7 +1208,9 @@ var CDATA = {
       end: cdata.end,
       value: {
         start: cdata.start + 9,
+        // strip <![CDATA[
         end: cdata.end - 3
+        // strip ]]>
       }
     });
   },
@@ -1363,7 +1383,7 @@ var CONCISE_HTML_CONTENT = {
         }
       }
       if (parentTag) {
-        if (parentTag.type === 1 /* text */ && code !== 45 /* HTML_BLOCK_DELIMITER */) {
+        if (parentTag.type === 1 /* text */ && code !== 45 /* HYPHEN */) {
           this.emitError(
             this.pos,
             8 /* INVALID_LINE_START */,
@@ -1395,8 +1415,8 @@ var CONCISE_HTML_CONTENT = {
             return;
           }
           break;
-        case 45 /* HTML_BLOCK_DELIMITER */:
-          if (this.lookAtCharCodeAhead(1) === 45 /* HTML_BLOCK_DELIMITER */) {
+        case 45 /* HYPHEN */:
+          if (this.lookAtCharCodeAhead(1) === 45 /* HYPHEN */) {
             this.enterState(states_exports.BEGIN_DELIMITED_HTML_BLOCK);
             this.pos--;
           } else {
@@ -1445,6 +1465,7 @@ var CONCISE_HTML_CONTENT = {
           end: child.end,
           value: {
             start: child.start + 2,
+            // strip //
             end: child.end
           }
         });
@@ -1455,7 +1476,9 @@ var CONCISE_HTML_CONTENT = {
           end: child.end,
           value: {
             start: child.start + 2,
+            // strip /*
             end: child.end - 2
+            // strip */,
           }
         });
         if (!this.consumeWhitespaceOnLine(0)) {
@@ -1515,7 +1538,9 @@ function exitDeclaration(parser, declaration, closeOffset) {
     end: declaration.end,
     value: {
       start: declaration.start + 2,
+      // strip <?
       end: declaration.end - closeOffset
+      // > or ?>
     }
   });
 }
@@ -1539,7 +1564,9 @@ var DTD = {
       end: documentType.end,
       value: {
         start: documentType.start + 2,
+        // strip <!
         end: documentType.end - 1
+        // strip >
       }
     });
   },
@@ -1947,7 +1974,9 @@ var HTML_COMMENT = {
       end: comment.end,
       value: {
         start: comment.start + 4,
+        // strip <!--
         end: comment.end - 3
+        // strip -->
       }
     });
   },
@@ -2073,6 +2102,7 @@ var HTML_CONTENT = {
           end: child.end,
           value: {
             start: child.start + 2,
+            // strip //
             end: child.end
           }
         });
@@ -2083,7 +2113,9 @@ var HTML_CONTENT = {
           end: child.end,
           value: {
             start: child.start + 2,
+            // strip /*
             end: child.end - 2
+            // strip */,
           }
         });
         break;
@@ -2306,7 +2338,9 @@ var PLACEHOLDER = {
       escape: placeholder.escape,
       value: {
         start: placeholder.start + (placeholder.escape ? 2 : 3),
+        // ignore ${ or $!{
         end: placeholder.end - 1
+        // ignore }
       }
     });
   },
@@ -2675,15 +2709,27 @@ var PARSED_STRING = {
 function createParser(handlers) {
   const parser = new Parser(handlers);
   return {
+    /**
+     * Parses code and calls the provided handlers.
+     */
     parse(code) {
       return parser.parse(code);
     },
+    /**
+     * Given an offset range in the current source code, reads and returns the substring in the input code.
+     */
     read(range) {
       return parser.read(range);
     },
+    /**
+     * Given a offset in the current source code, returns a Position object with line & character information.
+     */
     positionAt(offset) {
       return parser.positionAt(offset);
     },
+    /**
+     * Given a offset range in the current source code, returns a Location object with a start & end position information.
+     */
     locationAt(range) {
       return parser.locationAt(range);
     }

package/dist/states/ATTRIBUTE.d.ts

@@ -1,4 +1,4 @@
-import { StateDefinition, Range, Ranges, Meta } from "../internal";
+import { type StateDefinition, type Range, type Ranges, type Meta } from "../internal";
 declare const enum ATTR_STAGE {
     UNKNOWN = 0,
     NAME = 1,

package/dist/states/BEGIN_DELIMITED_HTML_BLOCK.d.ts

@@ -1,4 +1,4 @@
-import { Parser, StateDefinition, STATE, Meta } from "../internal";
+import { Parser, type StateDefinition, STATE, type Meta } from "../internal";
 export interface DelimitedHTMLBlockMeta extends Meta {
     delimiter: string;
     indent: string;

package/dist/states/CDATA.d.ts

@@ -1,3 +1,3 @@
-import { Parser, StateDefinition } from "../internal";
+import { Parser, type StateDefinition } from "../internal";
 export declare const CDATA: StateDefinition;
 export declare function checkForCDATA(parser: Parser): boolean;

package/dist/states/CLOSE_TAG.d.ts

@@ -1,3 +1,3 @@
-import { StateDefinition, Parser } from "../internal";
+import { type StateDefinition, Parser } from "../internal";
 export declare const CLOSE_TAG: StateDefinition;
 export declare function checkForClosingTag(parser: Parser): boolean;

package/dist/states/CONCISE_HTML_CONTENT.d.ts

@@ -1,2 +1,2 @@
-import { StateDefinition } from "../internal";
+import { type StateDefinition } from "../internal";
 export declare const CONCISE_HTML_CONTENT: StateDefinition;

package/dist/states/DECLARATION.d.ts

@@ -1,2 +1,2 @@
-import { StateDefinition } from "../internal";
+import { type StateDefinition } from "../internal";
 export declare const DECLARATION: StateDefinition;

package/dist/states/DTD.d.ts

@@ -1,2 +1,2 @@
-import { StateDefinition } from "../internal";
+import { type StateDefinition } from "../internal";
 export declare const DTD: StateDefinition;

package/dist/states/EXPRESSION.d.ts

@@ -1,4 +1,4 @@
-import { StateDefinition, Meta } from "../internal";
+import { type StateDefinition, type Meta } from "../internal";
 export interface ExpressionMeta extends Meta {
     groupStack: number[];
     operators: boolean;

package/dist/states/HTML_COMMENT.d.ts

@@ -1,2 +1,2 @@
-import { StateDefinition } from "../internal";
+import { type StateDefinition } from "../internal";
 export declare const HTML_COMMENT: StateDefinition;

package/dist/states/HTML_CONTENT.d.ts

@@ -1,4 +1,4 @@
-import { StateDefinition, Meta } from "../internal";
+import { type StateDefinition, type Meta } from "../internal";
 export interface HTMLContentMeta extends Meta {
     indent: string;
     singleLine: boolean;

package/dist/states/INLINE_SCRIPT.d.ts

@@ -1,4 +1,4 @@
-import { Range, StateDefinition, Meta } from "../internal";
+import { type Range, type StateDefinition, type Meta } from "../internal";
 interface ScriptletMeta extends Meta {
     block: boolean;
     value: Range;

package/dist/states/JS_COMMENT_BLOCK.d.ts

@@ -1,2 +1,2 @@
-import { StateDefinition } from "../internal";
+import { type StateDefinition } from "../internal";
 export declare const JS_COMMENT_BLOCK: StateDefinition;

package/dist/states/JS_COMMENT_LINE.d.ts

@@ -1,2 +1,2 @@
-import { StateDefinition } from "../internal";
+import { type StateDefinition } from "../internal";
 export declare const JS_COMMENT_LINE: StateDefinition;

package/dist/states/OPEN_TAG.d.ts

@@ -1,4 +1,4 @@
-import { StateDefinition, Ranges, Meta, TagType } from "../internal";
+import { type StateDefinition, type Ranges, type Meta, TagType } from "../internal";
 export declare enum TAG_STAGE {
     UNKNOWN = 0,
     VAR = 1,

package/dist/states/PARSED_STRING.d.ts

@@ -1,4 +1,4 @@
-import { StateDefinition, Meta } from "../internal";
+import { type StateDefinition, type Meta } from "../internal";
 interface ParsedStringMeta extends Meta {
     quoteCharCode: number;
 }

package/dist/states/PARSED_TEXT_CONTENT.d.ts

@@ -1,4 +1,4 @@
-import { StateDefinition, Meta } from "../internal";
+import { type StateDefinition, type Meta } from "../internal";
 export interface ParsedTextContentMeta extends Meta {
     indent: string;
     singleLine: boolean;

package/dist/states/PLACEHOLDER.d.ts

@@ -1,4 +1,4 @@
-import { Parser, StateDefinition, Meta } from "../internal";
+import { Parser, type StateDefinition, type Meta } from "../internal";
 interface PlaceholderMeta extends Meta {
     escape: boolean;
 }

package/dist/states/REGULAR_EXPRESSION.d.ts

@@ -1,4 +1,4 @@
-import { StateDefinition, Meta } from "../internal";
+import { type StateDefinition, type Meta } from "../internal";
 interface RegExpMeta extends Meta {
     isInCharSet: boolean;
 }

package/dist/states/STRING.d.ts

@@ -1,4 +1,4 @@
-import { StateDefinition, Meta } from "../internal";
+import { type StateDefinition, type Meta } from "../internal";
 interface StringMeta extends Meta {
     quoteCharCode: number;
 }

package/dist/states/TAG_NAME.d.ts

@@ -1,4 +1,4 @@
-import { CODE, StateDefinition, Ranges, Meta } from "../internal";
+import { CODE, type StateDefinition, type Ranges, type Meta } from "../internal";
 export interface TagNameMeta extends Meta, Ranges.Template {
     shorthandCode: -1 | CODE.NUMBER_SIGN | CODE.PERIOD;
 }

package/dist/states/TEMPLATE_STRING.d.ts

@@ -1,2 +1,2 @@
-import { StateDefinition } from "../internal";
+import { type StateDefinition } from "../internal";
 export declare const TEMPLATE_STRING: StateDefinition;

package/dist/util/constants.d.ts

@@ -23,7 +23,6 @@ export declare const enum CODE {
     CLOSE_CURLY_BRACE = 125,
     ASTERISK = 42,
     HYPHEN = 45,
-    HTML_BLOCK_DELIMITER = 45,
     DOLLAR = 36,
     PERCENT = 37,
     PERIOD = 46,

package/dist/util/util.d.ts

@@ -1,5 +1,5 @@
 import { type Parser } from "../internal";
-import { Location, Position } from "./constants";
+import { type Location, type Position } from "./constants";
 export declare function isWhitespaceCode(code: number): boolean;
 /**
  * Given a source code line offsets, a start offset and an end offset, returns a Location object with line & character information for the start and end offsets.

package/package.json

@@ -1,31 +1,33 @@
 {
   "name": "htmljs-parser",
   "description": "An HTML parser recognizes content and string placeholders and allows JavaScript expressions as attribute values",
-  "version": "5.5.1",
+  "version": "5.5.2",
   "devDependencies": {
-    "@changesets/changelog-github": "^0.4.7",
-    "@changesets/cli": "^2.25.2",
-    "@types/degit": "^2.8.3",
-    "@types/mocha": "^10.0.0",
-    "@types/node": "^18.11.9",
-    "@typescript-eslint/eslint-plugin": "^5.42.0",
-    "@typescript-eslint/parser": "^5.42.0",
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.1",
+    "@types/degit": "^2.8.6",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.10.6",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
     "cross-env": "^7.0.3",
     "degit": "^2.8.4",
-    "esbuild": "0.15.13",
-    "eslint": "^8.26.0",
-    "eslint-config-prettier": "^8.5.0",
-    "fast-glob": "^3.2.12",
+    "esbuild": "0.19.11",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.1",
+    "fast-glob": "^3.3.2",
     "fixpack": "^4.0.0",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
+    "husky": "^8.0.3",
+    "lint-staged": "^15.2.0",
     "mitata": "^0.1.6",
-    "mocha": "^10.1.0",
-    "mocha-snap": "^4.3.0",
+    "mocha": "^10.2.0",
+    "mocha-snap": "^5.0.0",
     "nyc": "^15.1.0",
-    "prettier": "^2.7.1",
-    "tsx": "^3.11.0",
-    "typescript": "^4.8.4"
+    "prettier": "^3.1.1",
+    "tsx": "^4.7.0",
+    "typescript": "^5.3.3"
   },
   "exports": {
     ".": {