htmljs-parser 2.11.2 → 3.0.0

package/dist/internal.d.ts

@@ -0,0 +1,4 @@
+export * from "./util/constants";
+export * from "./util/util";
+export * from "./core/Parser";
+export * as STATE from "./states";

package/dist/states/ATTRIBUTE.d.ts

@@ -0,0 +1,18 @@
+import { StateDefinition, Range, Ranges, Meta } from "../internal";
+declare const enum ATTR_STAGE {
+    UNKNOWN = 0,
+    NAME = 1,
+    VALUE = 2,
+    ARGUMENT = 3,
+    BLOCK = 4
+}
+export interface AttrMeta extends Meta {
+    stage: ATTR_STAGE;
+    name: undefined | Range;
+    valueStart: number;
+    args: boolean | Ranges.AttrMethod["params"];
+    spread: boolean;
+    bound: boolean;
+}
+export declare const ATTRIBUTE: StateDefinition<AttrMeta>;
+export {};

package/dist/states/BEGIN_DELIMITED_HTML_BLOCK.d.ts

@@ -0,0 +1,7 @@
+import { Parser, StateDefinition, STATE, Meta } from "../internal";
+export interface DelimitedHTMLBlockMeta extends Meta {
+    delimiter: string;
+    indent: string;
+}
+export declare const BEGIN_DELIMITED_HTML_BLOCK: StateDefinition<DelimitedHTMLBlockMeta>;
+export declare function handleDelimitedEOL(parser: Parser, newLineLength: number, content: STATE.ParsedTextContentMeta | STATE.HTMLContentMeta): boolean;

package/dist/states/CDATA.d.ts

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

package/dist/states/CLOSE_TAG.d.ts

@@ -0,0 +1,3 @@
+import { 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

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

package/dist/states/DECLARATION.d.ts

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

package/dist/states/DTD.d.ts

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

package/dist/states/EXPRESSION.d.ts

@@ -0,0 +1,9 @@
+import { StateDefinition, Meta } from "../internal";
+export interface ExpressionMeta extends Meta {
+    groupStack: number[];
+    terminator: number | (number | number[])[];
+    skipOperators: boolean;
+    terminatedByEOL: boolean;
+    terminatedByWhitespace: boolean;
+}
+export declare const EXPRESSION: StateDefinition<ExpressionMeta>;

package/dist/states/HTML_COMMENT.d.ts

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

package/dist/states/HTML_CONTENT.d.ts

@@ -0,0 +1,7 @@
+import { StateDefinition, Meta } from "../internal";
+export interface HTMLContentMeta extends Meta {
+    indent: string;
+    singleLine: boolean;
+    delimiter: undefined | string;
+}
+export declare const HTML_CONTENT: StateDefinition<HTMLContentMeta>;

package/dist/states/INLINE_SCRIPT.d.ts

@@ -0,0 +1,7 @@
+import { Range, StateDefinition, Meta } from "../internal";
+interface ScriptletMeta extends Meta {
+    block: boolean;
+    value: Range;
+}
+export declare const INLINE_SCRIPT: StateDefinition<ScriptletMeta>;
+export {};

package/dist/states/JS_COMMENT_BLOCK.d.ts

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

package/dist/states/JS_COMMENT_LINE.d.ts

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

package/dist/states/OPEN_TAG.d.ts

@@ -0,0 +1,25 @@
+import { StateDefinition, BODY_MODE, OpenTagEnding, Ranges, Meta } from "../internal";
+declare const enum TAG_STAGE {
+    UNKNOWN = 0,
+    VAR = 1,
+    ARGUMENT = 2,
+    PARAMS = 3,
+    ATTR_GROUP = 4
+}
+export interface OpenTagMeta extends Meta {
+    bodyMode: BODY_MODE;
+    stage: TAG_STAGE;
+    concise: boolean;
+    beginMixedMode?: boolean;
+    tagName: Ranges.Template;
+    shorthandEnd: number;
+    hasArgs: boolean;
+    hasAttrs: boolean;
+    hasShorthandId: boolean;
+    ending: OpenTagEnding;
+    indent: string;
+    nestedIndent: string | undefined;
+    parentTag: OpenTagMeta | undefined;
+}
+export declare const OPEN_TAG: StateDefinition<OpenTagMeta>;
+export {};

package/dist/states/PARSED_TEXT_CONTENT.d.ts

@@ -0,0 +1,7 @@
+import { StateDefinition, Meta } from "../internal";
+export interface ParsedTextContentMeta extends Meta {
+    indent: string;
+    singleLine: boolean;
+    delimiter: undefined | string;
+}
+export declare const PARSED_TEXT_CONTENT: StateDefinition<ParsedTextContentMeta>;

package/dist/states/PLACEHOLDER.d.ts

@@ -0,0 +1,7 @@
+import { Parser, StateDefinition, Meta } from "../internal";
+interface PlaceholderMeta extends Meta {
+    escape: boolean;
+}
+export declare const PLACEHOLDER: StateDefinition<PlaceholderMeta>;
+export declare function checkForPlaceholder(parser: Parser, code: number): boolean;
+export {};

package/dist/states/REGULAR_EXPRESSION.d.ts

@@ -0,0 +1,6 @@
+import { StateDefinition, Meta } from "../internal";
+interface RegExpMeta extends Meta {
+    isInCharSet: boolean;
+}
+export declare const REGULAR_EXPRESSION: StateDefinition<RegExpMeta>;
+export {};

package/dist/states/STRING.d.ts

@@ -0,0 +1,6 @@
+import { StateDefinition, Meta } from "../internal";
+interface StringMeta extends Meta {
+    quoteCharCode: number;
+}
+export declare const STRING: StateDefinition<StringMeta>;
+export {};

package/dist/states/TAG_NAME.d.ts

@@ -0,0 +1,5 @@
+import { CODE, StateDefinition, Ranges, Meta } from "../internal";
+export interface TagNameMeta extends Meta, Ranges.Template {
+    shorthandCode?: CODE.NUMBER_SIGN | CODE.PERIOD;
+}
+export declare const TAG_NAME: StateDefinition<TagNameMeta>;

package/dist/states/TEMPLATE_STRING.d.ts

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

package/dist/states/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./ATTRIBUTE";
+export * from "./BEGIN_DELIMITED_HTML_BLOCK";
+export * from "./CDATA";
+export * from "./CLOSE_TAG";
+export * from "./CONCISE_HTML_CONTENT";
+export * from "./DECLARATION";
+export * from "./DTD";
+export * from "./EXPRESSION";
+export * from "./HTML_COMMENT";
+export * from "./HTML_CONTENT";
+export * from "./INLINE_SCRIPT";
+export * from "./JS_COMMENT_BLOCK";
+export * from "./JS_COMMENT_LINE";
+export * from "./PARSED_TEXT_CONTENT";
+export * from "./PLACEHOLDER";
+export * from "./REGULAR_EXPRESSION";
+export * from "./STRING";
+export * from "./TAG_NAME";
+export * from "./TEMPLATE_STRING";
+export * from "./OPEN_TAG";

package/dist/util/constants.d.ts

@@ -0,0 +1,131 @@
+export declare const enum CODE {
+    NUMBER_0 = 48,
+    NUMBER_9 = 57,
+    UPPER_A = 65,
+    UPPER_Z = 90,
+    LOWER_A = 97,
+    LOWER_Z = 122,
+    BACK_SLASH = 92,
+    FORWARD_SLASH = 47,
+    OPEN_ANGLE_BRACKET = 60,
+    CLOSE_ANGLE_BRACKET = 62,
+    EXCLAMATION = 33,
+    QUESTION = 63,
+    OPEN_SQUARE_BRACKET = 91,
+    CLOSE_SQUARE_BRACKET = 93,
+    EQUAL = 61,
+    SINGLE_QUOTE = 39,
+    DOUBLE_QUOTE = 34,
+    BACKTICK = 96,
+    OPEN_PAREN = 40,
+    CLOSE_PAREN = 41,
+    OPEN_CURLY_BRACE = 123,
+    CLOSE_CURLY_BRACE = 125,
+    ASTERISK = 42,
+    HYPHEN = 45,
+    HTML_BLOCK_DELIMITER = 45,
+    DOLLAR = 36,
+    PERCENT = 37,
+    PERIOD = 46,
+    COMMA = 44,
+    COLON = 58,
+    SEMICOLON = 59,
+    NUMBER_SIGN = 35,
+    PIPE = 124,
+    NEWLINE = 10,
+    CARRIAGE_RETURN = 13,
+    SPACE = 32,
+    TAB = 9
+}
+export declare const enum BODY_MODE {
+    HTML = 0,
+    PARSED_TEXT = 1
+}
+export interface Position {
+    /**
+     * Line position in a document (zero-based).
+     */
+    line: number;
+    /**
+     * Character offset on a line in a document (zero-based).
+     */
+    character: number;
+}
+export interface Location {
+    start: Position;
+    end: Position;
+}
+export interface Range {
+    /**
+     * The start characters offset from the beginning of the document (zero-based).
+     */
+    start: number;
+    /**
+     * The end characters offset from the beginning of the document (zero-based).
+     */
+    end: number;
+}
+export declare namespace Ranges {
+    interface Value extends Range {
+        value: Range;
+    }
+    interface Template extends Range {
+        expressions: Value[];
+        quasis: Range[];
+    }
+    interface Error extends Range {
+        code: string;
+        message: string;
+    }
+    interface Scriptlet extends Value {
+        block: boolean;
+    }
+    interface Placeholder extends Value {
+        escape: boolean;
+    }
+    interface TagName extends Template {
+        concise: boolean;
+    }
+    interface AttrValue extends Value {
+        bound: boolean;
+    }
+    interface AttrMethod extends Range {
+        body: Value;
+        params: Value;
+    }
+    interface OpenTagEnd extends Range {
+        ending: OpenTagEnding;
+    }
+    interface CloseTag extends Range {
+        value: Range | undefined;
+    }
+}
+export declare const enum OpenTagEnding {
+    tag = 0,
+    self = 1,
+    void = 2,
+    code = 4
+}
+export interface Handlers {
+    onError?(data: Ranges.Error): void;
+    onText?(data: Range): void;
+    onComment?(data: Ranges.Value): void;
+    onCDATA?(data: Ranges.Value): void;
+    onDeclaration?(data: Ranges.Value): void;
+    onDoctype?(data: Ranges.Value): void;
+    onScriptlet?(data: Ranges.Scriptlet): void;
+    onPlaceholder?(data: Ranges.Placeholder): void;
+    onTagName?(data: Ranges.TagName): void;
+    onTagShorthandId?(data: Ranges.Template): void;
+    onTagShorthandClass?(data: Ranges.Template): void;
+    onTagVar?(data: Ranges.Value): void;
+    onTagArgs?(data: Ranges.Value): void;
+    onTagParams?(data: Ranges.Value): void;
+    onAttrName?(data: Range): void;
+    onAttrArgs?(data: Ranges.Value): void;
+    onAttrValue?(data: Ranges.AttrValue): void;
+    onAttrMethod?(data: Ranges.AttrMethod): void;
+    onAttrSpread?(data: Ranges.Value): void;
+    onOpenTagEnd?(data: Ranges.OpenTagEnd): void;
+    onCloseTag?(data: Ranges.CloseTag): void;
+}

package/dist/util/util.d.ts

@@ -0,0 +1,7 @@
+import { type Parser } from "../internal";
+import type { Location, Position, Range } from "./constants";
+export declare function isWhitespaceCode(code: number): boolean;
+export declare function getLoc(lines: number[], range: Range): Location;
+export declare function getPos(lines: number[], startLine: number, index: number): Position;
+export declare function getLines(src: string): number[];
+export declare function htmlEOF(this: Parser): void;

package/package.json

@@ -1,44 +1,81 @@
 {
   "name": "htmljs-parser",
   "description": "An HTML parser recognizes content and string placeholders and allows JavaScript expressions as attribute values",
+  "version": "3.0.0",
+  "author": "Phillip Gates-Idem <phillip.idem@gmail.com>",
+  "devDependencies": {
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
+    "@types/benchmark": "^2.1.1",
+    "@types/degit": "^2.8.3",
+    "@types/mocha": "^9.1.0",
+    "@types/node": "^17.0.22",
+    "@typescript-eslint/eslint-plugin": "^5.16.0",
+    "@typescript-eslint/parser": "^5.16.0",
+    "benchmark": "^2.1.4",
+    "cross-env": "^7.0.3",
+    "degit": "^2.8.4",
+    "esbuild": "0.14.27",
+    "esbuild-register": "^3.3.2",
+    "eslint": "^8.11.0",
+    "eslint-config-prettier": "^8.5.0",
+    "fast-glob": "^3.2.11",
+    "fixpack": "^4.0.0",
+    "husky": "^7.0.4",
+    "lint-staged": "^12.3.7",
+    "mocha": "^9.2.2",
+    "mocha-snap": "^4.3.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.6.0",
+    "semantic-release": "^19.0.2",
+    "typescript": "^4.6.2"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/__tests__",
+    "!**/*.tsbuildinfo"
+  ],
+  "homepage": "https://github.com/marko-js/htmljs-parser",
   "keywords": [
     "HTML",
-    "parser",
     "JavaScript",
-    "expressions",
     "browser",
-    "server",
+    "compiler",
+    "expressions",
     "nodejs",
-    "template",
-    "compiler"
+    "parser",
+    "server",
+    "template"
   ],
-  "main": "index.js",
-  "scripts": {
-    "test": "npm run mocha && npm run jshint",
-    "mocha": "node_modules/.bin/mocha --ui bdd --reporter spec ./test",
-    "jshint": "node_modules/.bin/jshint *.js"
-  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "repository": {
     "type": "git",
-    "url": "https://github.com/philidem/htmljs-parser.git"
-  },
-  "author": "Phillip Gates-Idem <phillip.idem@gmail.com>",
-  "maintainers": "Phillip Gates-Idem <phillip.idem@gmail.com>",
-  "dependencies": {
-    "char-props": "^0.1.5",
-    "complain": "^1.0.0"
-  },
-  "devDependencies": {
-    "@babel/runtime": "^7.12.5",
-    "chai": "^4.0.0",
-    "colors": "^1.1.2",
-    "jshint": "^2.8.0",
-    "mocha": "^4.0.0",
-    "mocha-autotest": "^1.0.3"
+    "url": "https://github.com/marko-js/htmljs-parser.git"
   },
-  "license": "MIT",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
+  "scripts": {
+    "bench": "npm run build && node -r esbuild-register ./src/__tests__/bench",
+    "build": "tsc -b && node -r esbuild-register build",
+    "ci:test": "nyc npm run mocha -- --forbid-pending --forbid-only",
+    "format": "npm run lint:eslint -- --fix && npm run lint:prettier -- --write && (fixpack || true)",
+    "lint": "tsc -b && npm run lint:eslint && npm run lint:prettier -- -l && fixpack",
+    "lint:eslint": "eslint -f visualstudio .",
+    "lint:prettier": "prettier \"./**/*{.ts,.js,.json,.md,.yml,rc}\"",
+    "mocha": "cross-env NODE_ENV=test mocha \"./src/**/__tests__/*.test.ts\"",
+    "prepare": "husky install",
+    "prepublishOnly": "npm run build",
+    "release": "semantic-release",
+    "report": "open ./coverage/lcov-report/index.html",
+    "test": "npm run mocha -- --watch",
+    "test:inspect": "npm test -- --inspect",
+    "test:update": "npm run mocha -- --update"
   },
-  "version": "2.11.2"
+  "types": "dist/index.d.ts"
 }

package/.jshintrc

@@ -1,29 +0,0 @@
-{
-    "node" : true,
-    "esnext": true,
-    "boss" : false,
-    "curly": false,
-    "debug": false,
-    "devel": false,
-    "eqeqeq": true,
-    "evil": true,
-    "forin": false,
-    "immed": true,
-    "laxbreak": false,
-    "newcap": true,
-    "noarg": true,
-    "noempty": false,
-    "nonew": true,
-    "nomen": false,
-    "onevar": false,
-    "plusplus": false,
-    "regexp": false,
-    "undef": true,
-    "sub": false,
-    "white": false,
-    "eqeqeq": false,
-    "latedef": false,
-    "unused": "vars",
-    "strict": false,
-    "eqnull": true
-}

package/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-node_js:
-- "10"
-- "12"
-- "14"
-- "15"
-language: node_js
-script: "npm test"

package/BaseParser.js

@@ -1,188 +0,0 @@
-'use strict';
-
-var CODE_NEWLINE = 10;
-var CODE_CARRIAGE_RETURN = 13;
-
-class Parser {
-    static createState(mixins) {
-        return mixins;
-    }
-
-    constructor(options) {
-        this.reset();
-    }
-
-    reset() {
-        // current absolute character position
-        this.pos = -1;
-
-        // The maxPos property is the last absolute character position that is
-        // readable based on the currently received chunks
-        this.maxPos = -1;
-
-        // the current parser state
-        this.state = null;
-
-        // The raw string that we are parsing
-        this.data = this.src = null;
-
-        this.filename = null;
-    }
-
-    setInitialState(initialState) {
-        this.initialState = initialState;
-    }
-
-    enterState(state) {
-        if (this.state === state) {
-            // Re-entering the same state can lead to unexpected behavior
-            // so we should throw error to catch these types of mistakes
-            throw new Error('Re-entering the current state is illegal - ' + state.name);
-        }
-
-        var oldState;
-        if ((oldState = this.state) && oldState.leave) {
-            // console.log('Leaving state ' + oldState.name);
-            oldState.leave.call(this, state);
-        }
-
-        // console.log('Entering state ' + state.name);
-
-        this.state = state;
-
-        if (state.enter) {
-            state.enter.call(this, oldState);
-        }
-    }
-
-    /**
-     * Look ahead to see if the given str matches the substring sequence
-     * beyond
-     */
-    lookAheadFor(str, startPos) {
-        // Have we read enough chunks to read the string that we need?
-        if (startPos == null) {
-            startPos = this.pos + 1;
-        }
-        var len = str.length;
-        var endPos = startPos + len;
-
-        if (endPos > this.maxPos + 1) {
-            return undefined;
-        }
-
-        var found = this.data.substring(startPos, endPos);
-        return (found === str) ? str : undefined;
-    }
-
-    /**
-     * Look ahead to a character at a specific offset.
-     * The callback will be invoked with the character
-     * at the given position.
-     */
-    lookAtCharAhead(offset, startPos) {
-        if (startPos == null) {
-            startPos = this.pos;
-        }
-        return this.data.charAt(startPos + offset);
-    }
-
-    lookAtCharCodeAhead(offset, startPos) {
-        if (startPos == null) {
-            startPos = this.pos;
-        }
-        return this.data.charCodeAt(startPos + offset);
-    }
-
-    rewind(offset) {
-        this.pos -= offset;
-    }
-
-    skip(offset) {
-        // console.log('-- ' + JSON.stringify(this.data.substring(this.pos, this.pos + offset)) + ' --  ' + 'SKIPPED'.gray);
-        this.pos += offset;
-    }
-
-    end() {
-        this.pos = this.maxPos + 1;
-    }
-
-    substring(pos, endPos) {
-        return this.data.substring(pos, endPos);
-    }
-
-    parse(data, filename) {
-        if (data == null) {
-            return;
-        }
-
-        // call the constructor function again because we have a contract that
-        // it will fully reset the parser
-        this.reset();
-
-        if (Array.isArray(data)) {
-            data = data.join('');
-        }
-
-        this.src = data; // This is the unmodified data used for reporting warnings
-        this.filename = filename;
-        this.data = data;
-        this.maxPos = data.length - 1;
-
-        // Enter initial state
-        if (this.initialState) {
-            this.enterState(this.initialState);
-        }
-
-        // Move to first position
-        // Skip the byte order mark (BOM) sequence
-        // at the beginning of the file if there is one:
-        // - https://en.wikipedia.org/wiki/Byte_order_mark
-        // > The Unicode Standard permits the BOM in UTF-8, but does not require or recommend its use.
-        this.pos = data.charCodeAt(0) === 0xFEFF ? 1 : 0;
-
-        if (!this.state) {
-            // Cannot resume when parser has no state
-            return;
-        }
-
-        var pos;
-        while ((pos = this.pos) <= this.maxPos) {
-            let ch = data[pos];
-            let code = ch.charCodeAt(0);
-            let state = this.state;
-
-            if (code === CODE_NEWLINE) {
-                if (state.eol) {
-                    state.eol.call(this, ch);
-                }
-                this.pos++;
-                continue;
-            } else if (code === CODE_CARRIAGE_RETURN) {
-                let nextPos = pos + 1;
-                if (nextPos < data.length && data.charCodeAt(nextPos) === CODE_NEWLINE) {
-                    if (state.eol) {
-                        state.eol.call(this, '\r\n');
-                    }
-                    this.pos+=2;
-                    continue;
-                }
-            }
-
-            // console.log('-- ' + JSON.stringify(ch) + ' --  ' + this.state.name.gray);
-
-            // We assume that every state will have "char" function
-            state.char.call(this, ch, code);
-
-            // move to next position
-            this.pos++;
-        }
-
-        let state = this.state;
-        if (state && state.eof) {
-            state.eof.call(this);
-        }
-    }
-}
-
-module.exports = Parser;