@html-eslint/eslint-plugin 0.40.1 → 0.40.3-alpha.0

package/lib/index.js

@@ -6,10 +6,13 @@ const { name, version } = require("../package.json");
 /**
  * @typedef {import("./rules")} AllRules
  * @typedef {import("./configs/recommended")} RecommendedConfig
+ * @typedef {{name: string, version: string}} PluginMeta
+ * @typedef {{recommended: RecommendedConfig, "flat/recommended": import("eslint").Linter.FlatConfig }} HtmlESLintConfigs
+ * @typedef {{html: HTMLLanguage}} Languages
  */
 
 /**
- * @type {{meta: { name: string, version: string }, rules: AllRules, configs: {recommended: RecommendedConfig, "flat/recommended": import("eslint").Linter.FlatConfig }}}
+ * @type {{meta: PluginMeta, rules: AllRules, configs: HtmlESLintConfigs, languages: Languages}}
  */
 const plugin = {
   meta: {

package/lib/languages/html-language.js

@@ -65,16 +65,24 @@ class HTMLLanguage {
    * @param {File} file
    * @param {Object} [context]
    * @param {LanguageOptions} context.languageOptions
+   * @returns {{ok: true; ast: any; comments: any[]} | {ok: false, errors: unknown[]}}
    */
   parse(file, context) {
     const code = /**  @type {string} */ (file.body);
     const languageOptions = (context && context.languageOptions) || {};
-    const result = parseForESLint(code, languageOptions);
-    return {
-      ok: true,
-      ast: result.ast,
-      comments: result.ast.comments,
-    };
+    try {
+      const result = parseForESLint(code, languageOptions);
+      return {
+        ok: true,
+        ast: result.ast,
+        comments: result.ast.comments,
+      };
+    } catch (e) {
+      return {
+        ok: false,
+        errors: [e],
+      };
+    }
   }
 
   /**

package/lib/languages/html-source-code.js

@@ -5,6 +5,7 @@
  *  @typedef {import("@eslint/core").TraversalStep} TraversalStep
  *  @typedef {import("@html-eslint/types").CommentContent} CommentContent
  *  @typedef {import("@html-eslint/types").AnyHTMLNode} AnyHTMLNode
+ *  @typedef {import("@eslint/core").Position} Position
  *  @typedef {import("../types").BaseNode} BaseNode
  */
 const {
@@ -12,10 +13,15 @@ const {
   ConfigCommentParser,
   Directive,
 } = require("@eslint/plugin-kit");
-const { SourceCode } = require("eslint");
 const { HTMLTraversalStep, STEP_PHASE } = require("./html-traversal-step");
 const { visitorKeys } = require("@html-eslint/parser");
 
+const lineBreakPattern = /\r\n|[\r\n\u2028\u2029]/u;
+
+function createGlobalLinebreakMatcher() {
+  return new RegExp(lineBreakPattern.source, "gu");
+}
+
 const INLINE_CONFIG =
   /^\s*(?:eslint(?:-enable|-disable(?:(?:-next)?-line)?)?)(?:\s|$)/u;
 
@@ -27,10 +33,7 @@ class HTMLSourceCode extends TextSourceCodeBase {
    */
   constructor({ ast, text, comments }) {
     super({ ast, text });
-    /**
-     * @property
-     */
-    this.eslintSourceCode = new SourceCode(text, ast);
+
     /**
      * @property
      */
@@ -40,6 +43,14 @@ class HTMLSourceCode extends TextSourceCodeBase {
      */
     this.comments = comments;
     this.parentsMap = new Map();
+
+    this.lineStartIndices = [0];
+
+    const lineEndingPattern = createGlobalLinebreakMatcher();
+    let match;
+    while ((match = lineEndingPattern.exec(this.text))) {
+      this.lineStartIndices.push(match.index + match[0].length);
+    }
   }
 
   /**
@@ -62,20 +73,88 @@ class HTMLSourceCode extends TextSourceCodeBase {
     return this.lines;
   }
 
+  // Copied from eslint source code
   /**
-   * @param {import("@eslint/core").Position} loc
-   * @returns
+   * @see https://github.com/eslint/eslint/blob/f60f2764971a33e252be13e560dccf21f554dbf1/lib/languages/js/source-code/source-code.js#L745
+   * @param {Position} loc
+   * @returns {number}
    */
   getIndexFromLoc(loc) {
-    return this.eslintSourceCode.getIndexFromLoc(loc);
+    if (
+      typeof loc !== "object" ||
+      typeof loc.line !== "number" ||
+      typeof loc.column !== "number"
+    ) {
+      throw new TypeError(
+        "Expected `loc` to be an object with numeric `line` and `column` properties."
+      );
+    }
+
+    if (loc.line <= 0) {
+      throw new RangeError(
+        `Line number out of range (line ${loc.line} requested). Line numbers should be 1-based.`
+      );
+    }
+
+    if (loc.line > this.lineStartIndices.length) {
+      throw new RangeError(
+        `Line number out of range (line ${loc.line} requested, but only ${this.lineStartIndices.length} lines present).`
+      );
+    }
+
+    const lineStartIndex = this.lineStartIndices[loc.line - 1];
+    const lineEndIndex =
+      loc.line === this.lineStartIndices.length
+        ? this.text.length
+        : this.lineStartIndices[loc.line];
+    const positionIndex = lineStartIndex + loc.column;
+    if (
+      (loc.line === this.lineStartIndices.length &&
+        positionIndex > lineEndIndex) ||
+      (loc.line < this.lineStartIndices.length && positionIndex >= lineEndIndex)
+    ) {
+      throw new RangeError(
+        `Column number out of range (column ${loc.column} requested, but the length of line ${loc.line} is ${lineEndIndex - lineStartIndex}).`
+      );
+    }
+
+    return positionIndex;
   }
 
+  // Copied from eslint source code
   /**
+   * @see https://github.com/eslint/eslint/blob/f60f2764971a33e252be13e560dccf21f554dbf1/lib/languages/js/source-code/source-code.js#L694
    * @param {number} index
-   * @returns {import("@eslint/core").Position}
+   * @returns {Position}
    */
   getLocFromIndex(index) {
-    return this.eslintSourceCode.getLocFromIndex(index);
+    if (typeof index !== "number") {
+      throw new TypeError("Expected `index` to be a number.");
+    }
+
+    if (index < 0 || index > this.text.length) {
+      throw new RangeError(
+        `Index out of range (requested index ${index}, but source text has length ${this.text.length}).`
+      );
+    }
+    if (index === this.text.length) {
+      return {
+        line: this.lines.length,
+        // @ts-ignore
+        column: this.lines.at(-1).length,
+      };
+    }
+
+    const lineNumber =
+      // @ts-ignore
+      index >= this.lineStartIndices.at(-1)
+        ? this.lineStartIndices.length
+        : this.lineStartIndices.findIndex((el) => index < el);
+
+    return {
+      line: lineNumber,
+      column: index - this.lineStartIndices[lineNumber - 1],
+    };
   }
 
   getInlineConfigNodes() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.40.1",
+  "version": "0.40.3-alpha.0",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -39,12 +39,12 @@
   ],
   "dependencies": {
     "@eslint/plugin-kit": "0.2.8",
+    "@html-eslint/parser": "^0.40.0",
     "@html-eslint/template-parser": "^0.40.0",
     "@html-eslint/template-syntax-parser": "^0.40.0"
   },
   "devDependencies": {
     "@eslint/core": "0.13.0",
-    "@html-eslint/parser": "^0.40.0",
     "@html-eslint/types": "^0.40.0",
     "@types/eslint": "^9.6.1",
     "@types/estree": "^0.0.47",
@@ -53,5 +53,5 @@
     "espree": "^10.3.0",
     "typescript": "^5.7.2"
   },
-  "gitHead": "595b1231bd0876792b229170edaecd4a7239d7fb"
+  "gitHead": "873a490bff042b8ad9b8451210f08688c683f510"
 }

package/types/index.d.ts

@@ -2,23 +2,21 @@ export = plugin;
 /**
  * @typedef {import("./rules")} AllRules
  * @typedef {import("./configs/recommended")} RecommendedConfig
+ * @typedef {{name: string, version: string}} PluginMeta
+ * @typedef {{recommended: RecommendedConfig, "flat/recommended": import("eslint").Linter.FlatConfig }} HtmlESLintConfigs
+ * @typedef {{html: HTMLLanguage}} Languages
  */
 /**
- * @type {{meta: { name: string, version: string }, rules: AllRules, configs: {recommended: RecommendedConfig, "flat/recommended": import("eslint").Linter.FlatConfig }}}
+ * @type {{meta: PluginMeta, rules: AllRules, configs: HtmlESLintConfigs, languages: Languages}}
  */
 declare const plugin: {
-    meta: {
-        name: string;
-        version: string;
-    };
+    meta: PluginMeta;
     rules: AllRules;
-    configs: {
-        recommended: RecommendedConfig;
-        "flat/recommended": import("eslint").Linter.FlatConfig;
-    };
+    configs: HtmlESLintConfigs;
+    languages: Languages;
 };
 declare namespace plugin {
-    export { AllRules, RecommendedConfig };
+    export { AllRules, RecommendedConfig, PluginMeta, HtmlESLintConfigs, Languages };
 }
 type AllRules = {
     "require-lang": import("./types").RuleModule<[]>;
@@ -93,4 +91,16 @@ type RecommendedConfig = {
         "@html-eslint/use-baseline": string;
     };
 };
+type PluginMeta = {
+    name: string;
+    version: string;
+};
+type HtmlESLintConfigs = {
+    recommended: RecommendedConfig;
+    "flat/recommended": import("eslint").Linter.FlatConfig;
+};
+type Languages = {
+    html: HTMLLanguage;
+};
+import { HTMLLanguage } from "./languages/html-language";
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.js"],"names":[],"mappings":";AAKA;;;GAGG;AAEH;;GAEG;AACH,sBAFU;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE;QAAC,WAAW,EAAE,iBAAiB,CAAC;QAAC,kBAAkB,EAAE,OAAO,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAA;KAAE,CAAA;CAAC,CAetK"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.js"],"names":[],"mappings":";AAKA;;;;;;GAMG;AAEH;;GAEG;AACH,sBAFU;IAAC,IAAI,EAAE,UAAU,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,iBAAiB,CAAC;IAAC,SAAS,EAAE,SAAS,CAAA;CAAC,CAe7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBArBW;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC;yBAC/B;IAAC,WAAW,EAAE,iBAAiB,CAAC;IAAC,kBAAkB,EAAE,OAAO,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAA;CAAE;iBACzF;IAAC,IAAI,EAAE,YAAY,CAAA;CAAC"}

package/types/languages/html-language.d.ts

@@ -37,13 +37,17 @@ export class HTMLLanguage {
      * @param {File} file
      * @param {Object} [context]
      * @param {LanguageOptions} context.languageOptions
+     * @returns {{ok: true; ast: any; comments: any[]} | {ok: false, errors: unknown[]}}
      */
     parse(file: File, context?: {
         languageOptions: LanguageOptions;
     }): {
-        ok: boolean;
+        ok: true;
         ast: any;
-        comments: any;
+        comments: any[];
+    } | {
+        ok: false;
+        errors: unknown[];
     };
     /**
      * @param {File} file

package/types/languages/html-language.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-language.d.ts","sourceRoot":"","sources":["../../lib/languages/html-language.js"],"names":[],"mappings":"mBAIa,OAAO,cAAc,EAAE,IAAI;8BAC3B,OAAO,qBAAqB,EAAE,aAAa;AAFxD;;;GAGG;AACH;IAEI;;;OAGG;IACH,UAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,WAFU,CAAC,GAAC,CAAC,CAEK;IAElB;;;OAGG;IACH,aAFU,CAAC,GAAC,CAAC,CAEO;IAEpB;;OAEG;IACH,aAFU,MAAM,CAES;IAEzB;;;OAGG;IACH,aAFU,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAEJ;IAGhC;;OAEG;IACH,yCAFW,eAAe,QAqBzB;IAED;;;;OAIG;IACH,YAJW,IAAI,YAEZ;QAAiC,eAAe,EAAxC,eAAe;KACzB;;;;MAUA;IAED;;;OAGG;IACH,uBAHW,IAAI,eACJ,GAAG,kBAQb;CACF"}
+{"version":3,"file":"html-language.d.ts","sourceRoot":"","sources":["../../lib/languages/html-language.js"],"names":[],"mappings":"mBAIa,OAAO,cAAc,EAAE,IAAI;8BAC3B,OAAO,qBAAqB,EAAE,aAAa;AAFxD;;;GAGG;AACH;IAEI;;;OAGG;IACH,UAFU,MAAM,CAEM;IAEtB;;;OAGG;IACH,WAFU,CAAC,GAAC,CAAC,CAEK;IAElB;;;OAGG;IACH,aAFU,CAAC,GAAC,CAAC,CAEO;IAEpB;;OAEG;IACH,aAFU,MAAM,CAES;IAEzB;;;OAGG;IACH,aAFU,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAEJ;IAGhC;;OAEG;IACH,yCAFW,eAAe,QAqBzB;IAED;;;;;OAKG;IACH,YALW,IAAI,YAEZ;QAAiC,eAAe,EAAxC,eAAe;KACvB,GAAU;QAAC,EAAE,EAAE,IAAI,CAAC;QAAC,GAAG,EAAE,GAAG,CAAC;QAAC,QAAQ,EAAE,GAAG,EAAE,CAAA;KAAC,GAAG;QAAC,EAAE,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,OAAO,EAAE,CAAA;KAAC,CAkBlF;IAED;;;OAGG;IACH,uBAHW,IAAI,eACJ,GAAG,kBAQb;CACF"}

package/types/languages/html-source-code.d.ts

@@ -4,6 +4,7 @@ export type DirectiveType = import("@eslint/plugin-kit").DirectiveType;
 export type TraversalStep = import("@eslint/core").TraversalStep;
 export type CommentContent = import("@html-eslint/types").CommentContent;
 export type AnyHTMLNode = import("@html-eslint/types").AnyHTMLNode;
+export type Position = import("@eslint/core").Position;
 export type BaseNode = import("../types").BaseNode;
 export class HTMLSourceCode extends TextSourceCodeBase {
     /**
@@ -14,10 +15,6 @@ export class HTMLSourceCode extends TextSourceCodeBase {
         text: string;
         comments: CommentContent[];
     });
-    /**
-     * @property
-     */
-    eslintSourceCode: SourceCode;
     /**
      * @property
      */
@@ -27,6 +24,7 @@ export class HTMLSourceCode extends TextSourceCodeBase {
      */
     comments: import("@html-eslint/types").CommentContent[];
     parentsMap: Map<any, any>;
+    lineStartIndices: number[];
     /**
      * @param {BaseNode} node
      * @returns {[number, number]}
@@ -39,15 +37,17 @@ export class HTMLSourceCode extends TextSourceCodeBase {
     getLoc(node: BaseNode): import("@eslint/plugin-kit").SourceLocation;
     getLines(): string[];
     /**
-     * @param {import("@eslint/core").Position} loc
-     * @returns
+     * @see https://github.com/eslint/eslint/blob/f60f2764971a33e252be13e560dccf21f554dbf1/lib/languages/js/source-code/source-code.js#L745
+     * @param {Position} loc
+     * @returns {number}
      */
-    getIndexFromLoc(loc: import("@eslint/core").Position): number;
+    getIndexFromLoc(loc: Position): number;
     /**
+     * @see https://github.com/eslint/eslint/blob/f60f2764971a33e252be13e560dccf21f554dbf1/lib/languages/js/source-code/source-code.js#L694
      * @param {number} index
-     * @returns {import("@eslint/core").Position}
+     * @returns {Position}
      */
-    getLocFromIndex(index: number): import("@eslint/core").Position;
+    getLocFromIndex(index: number): Position;
     getInlineConfigNodes(): import("@html-eslint/types").CommentContent[];
     getDisableDirectives(): {
         problems: {
@@ -65,6 +65,5 @@ export class HTMLSourceCode extends TextSourceCodeBase {
     getParent(node: AnyHTMLNode): any;
 }
 import { TextSourceCodeBase } from "@eslint/plugin-kit";
-import { SourceCode } from "eslint";
 import { Directive } from "@eslint/plugin-kit";
 //# sourceMappingURL=html-source-code.d.ts.map

package/types/languages/html-source-code.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-source-code.d.ts","sourceRoot":"","sources":["../../lib/languages/html-source-code.js"],"names":[],"mappings":"sBACc,OAAO,QAAQ,EAAE,GAAG,CAAC,OAAO;6BAC5B,OAAO,oBAAoB,EAAE,cAAc;4BAC3C,OAAO,oBAAoB,EAAE,aAAa;4BAC1C,OAAO,cAAc,EAAE,aAAa;6BACpC,OAAO,oBAAoB,EAAE,cAAc;0BAC3C,OAAO,oBAAoB,EAAE,WAAW;uBACxC,OAAO,UAAU,EAAE,QAAQ;AAgBzC;IACE;;OAEG;IACH,qCAFW;QAAC,GAAG,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,cAAc,EAAE,CAAA;KAAC,EAiBlE;IAbC;;OAEG;IACH,6BAAiD;IACjD;;OAEG;IACH,kCAAc;IACd;;OAEG;IACH,wDAAwB;IACxB,0BAA2B;IAG7B;;;OAGG;IACH,eAHW,QAAQ,GACN,CAAC,MAAM,EAAE,MAAM,CAAC,CAI5B;IAED;;;OAGG;IACH,aAHW,QAAQ,GACN,OAAO,oBAAoB,EAAE,cAAc,CAIvD;IAED,qBAEC;IAED;;;OAGG;IACH,qBAHW,OAAO,cAAc,EAAE,QAAQ,UAKzC;IAED;;;OAGG;IACH,uBAHW,MAAM,GACJ,OAAO,cAAc,EAAE,QAAQ,CAI3C;IAED,sEAEC;IAED;;oBAEqB,IAAI,GAAG,MAAM;qBAAW,MAAM;iBAAO,cAAc;;;MA8CvE;IAED,mDAgDC;IAED;;;OAGG;IACH,gBAHW,WAAW,OAKrB;CACF"}
+{"version":3,"file":"html-source-code.d.ts","sourceRoot":"","sources":["../../lib/languages/html-source-code.js"],"names":[],"mappings":"sBACc,OAAO,QAAQ,EAAE,GAAG,CAAC,OAAO;6BAC5B,OAAO,oBAAoB,EAAE,cAAc;4BAC3C,OAAO,oBAAoB,EAAE,aAAa;4BAC1C,OAAO,cAAc,EAAE,aAAa;6BACpC,OAAO,oBAAoB,EAAE,cAAc;0BAC3C,OAAO,oBAAoB,EAAE,WAAW;uBACxC,OAAO,cAAc,EAAE,QAAQ;uBAC/B,OAAO,UAAU,EAAE,QAAQ;AAqBzC;IACE;;OAEG;IACH,qCAFW;QAAC,GAAG,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,cAAc,EAAE,CAAA;KAAC,EAsBlE;IAjBC;;OAEG;IACH,kCAAc;IACd;;OAEG;IACH,wDAAwB;IACxB,0BAA2B;IAE3B,2BAA2B;IAS7B;;;OAGG;IACH,eAHW,QAAQ,GACN,CAAC,MAAM,EAAE,MAAM,CAAC,CAI5B;IAED;;;OAGG;IACH,aAHW,QAAQ,GACN,OAAO,oBAAoB,EAAE,cAAc,CAIvD;IAED,qBAEC;IAGD;;;;OAIG;IACH,qBAHW,QAAQ,GACN,MAAM,CA0ClB;IAGD;;;;OAIG;IACH,uBAHW,MAAM,GACJ,QAAQ,CA8BpB;IAED,sEAEC;IAED;;oBAEqB,IAAI,GAAG,MAAM;qBAAW,MAAM;iBAAO,cAAc;;;MA8CvE;IAED,mDAgDC;IAED;;;OAGG;IACH,gBAHW,WAAW,OAKrB;CACF"}