@html-eslint/eslint-plugin 0.35.0 → 0.35.2

package/lib/rules/quotes.js

@@ -1,10 +1,12 @@
 /**
  * @typedef { import("eslint").AST.Range } Range
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Attribute } Attribute
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").ScriptTag } ScriptTag
- * @typedef { import("../types").StyleTag } StyleTag
+ * @typedef { import("@html-eslint/types").Attribute } Attribute
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").ScriptTag } ScriptTag
+ * @typedef { import("@html-eslint/types").StyleTag } StyleTag
+ *
+ * @typedef {"single" | "double"} Option
+ * @typedef { import("../types").RuleModule<[Option]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-attrs.js

@@ -1,13 +1,15 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").ScriptTag } ScriptTag
- * @typedef { import("../types").StyleTag } StyleTag
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").ScriptTag } ScriptTag
+ * @typedef { import("@html-eslint/types").StyleTag } StyleTag
  *
  * @typedef {Object} Option
  * @property {string} tag
  * @property {string} attr
- * @property {string | undefined} value
+ * @property {string} [value]
+ *
+ * @typedef { import("../types").RuleModule<Option[]> } RuleModule
+ *
  */
 
 const { NODE_TYPES } = require("@html-eslint/parser");

package/lib/rules/require-button-type.js

@@ -1,5 +1,5 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-closing-tags.js

@@ -1,6 +1,10 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ *
+ * @typedef {Object} Option
+ * @property {"always" | "never"} [Option.selfClosing]
+ * @property {string[]} [Option.selfClosingCustomPatterns]
+ * @typedef { import("../types").RuleModule<[Option]> } RuleModule
  */
 
 const { RULE_CATEGORY, VOID_ELEMENTS } = require("../constants");

package/lib/rules/require-doctype.js

@@ -1,5 +1,5 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-explicit-size.js

@@ -1,7 +1,12 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").AnyNode } AnyNode
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
+ *
+ * @typedef {Object} Option
+ * @property {string[]} [Option.allowClass]
+ * @property {string[]} [Option.allowId]
+ * @typedef { import("../types").RuleModule<[Option]> } RuleModule
+ *
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-form-method.js

@@ -1,5 +1,5 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { NodeTypes } = require("es-html-parser");

package/lib/rules/require-frame-title.js

@@ -1,5 +1,5 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-img-alt.js

@@ -1,6 +1,10 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ *
+ * @typedef {Object} Option
+ * @property {string[]} [Option.substitute]
+ *
+ * @typedef { import("../types").RuleModule<[Option]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -56,12 +60,9 @@ module.exports = {
         }
         if (!hasAltAttrAndValue(node, substitute)) {
           context.report({
-            node: {
-              loc: {
-                start: node.openStart.loc.start,
-                end: node.openEnd.loc.end,
-              },
-              range: [node.openStart.range[0], node.openEnd.range[1]],
+            loc: {
+              start: node.openStart.loc.start,
+              end: node.openEnd.loc.end,
             },
             messageId: MESSAGE_IDS.MISSING_ALT,
           });

package/lib/rules/require-input-label.js

@@ -1,6 +1,6 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-lang.js

@@ -1,5 +1,5 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -41,12 +41,9 @@ module.exports = {
         const langAttr = findAttr(node, "lang");
         if (!langAttr) {
           context.report({
-            node: {
-              loc: {
-                start: node.openStart.loc.start,
-                end: node.openEnd.loc.end,
-              },
-              range: [node.openStart.range[0], node.openEnd.range[1]],
+            loc: {
+              start: node.openStart.loc.start,
+              end: node.openEnd.loc.end,
             },
             messageId: MESSAGE_IDS.MISSING,
           });

package/lib/rules/require-li-container.js

@@ -1,5 +1,5 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { NODE_TYPES } = require("@html-eslint/parser");

package/lib/rules/require-meta-charset.js

@@ -1,7 +1,7 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").AnyNode } AnyNode
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-meta-description.js

@@ -1,7 +1,7 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").AnyNode } AnyNode
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 const { RULE_CATEGORY } = require("../constants");
 const { filter } = require("./utils/array");

package/lib/rules/require-meta-viewport.js

@@ -1,7 +1,7 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").AnyNode } AnyNode
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-open-graph-protocol.js

@@ -1,7 +1,10 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- *  @typedef { import("../types").AnyNode } AnyNode
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
+ *
+ * @typedef {string[]} Option
+ *
+ * @typedef { import("../types").RuleModule<[Option]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/require-title.js

@@ -1,8 +1,8 @@
 /**
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Tag } Tag
- * @typedef { import("../types").Text } Text
- * @typedef { import("../types").AnyNode } AnyNode
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").Text } Text
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
+ * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
 const { RULE_CATEGORY } = require("../constants");

package/lib/rules/sort-attrs.js

@@ -1,8 +1,11 @@
 /**
- * @typedef { import("eslint").Rule.RuleFixer } RuleFixer
- * @typedef { import("../types").RuleModule } RuleModule
- * @typedef { import("../types").Attribute } Attribute
- * @typedef { import("../types").Text } Text
+ * @typedef { import("../types").RuleFixer } RuleFixer
+ * @typedef { import("@html-eslint/types").Attribute } Attribute
+ * @typedef { import("@html-eslint/types").Text } Text
+ *
+ * @typedef {Object} Option
+ * @property {string[]} [Option.priority]
+ * @typedef { import("../types").RuleModule<[Option]> } RuleModule
  */
 
 const { hasTemplate } = require("./utils/node");
@@ -53,7 +56,7 @@ module.exports = {
     /**
      * @type {string[]}
      */
-    const priority = option.priority;
+    const priority = option.priority || [];
 
     /**
      * @param {Attribute} attrA
@@ -165,12 +168,9 @@ module.exports = {
         const first = unsorted[0];
         const last = unsorted[unsorted.length - 1];
         context.report({
-          node: {
-            range: [first.range[0], last.range[1]],
-            loc: {
-              start: first.loc.start,
-              end: last.loc.end,
-            },
+          loc: {
+            start: first.loc.start,
+            end: last.loc.end,
           },
           messageId: MESSAGE_IDS.UNSORTED,
           fix(fixer) {

package/lib/rules/utils/node.js

@@ -1,23 +1,22 @@
 /**
- * @typedef { import("../../types").Attribute } Attribute
- * @typedef { import("../../types").Tag } Tag
- * @typedef { import("../../types").ScriptTag } ScriptTag
- * @typedef { import("../../types").StyleTag } StyleTag
+ * @typedef { import("@html-eslint/types").Attribute } Attribute
+ * @typedef { import("@html-eslint/types").Tag } Tag
+ * @typedef { import("@html-eslint/types").ScriptTag } ScriptTag
+ * @typedef { import("@html-eslint/types").StyleTag } StyleTag
+ * @typedef { import("@html-eslint/types").AnyNode } AnyNode
  * @typedef { import("../../types").Line } Line
- * @typedef { import("../../types").Text } Text
- * @typedef { import("../../types").CommentContent } CommentContent
- * @typedef { import("../../types").Comment } Comment
- * @typedef { import("../../types").AnyNode } AnyNode
- * @typedef { import("../../types").AttributeValue } AttributeValue
- * @typedef { import("../../types").AttributeKey } AttributeKey
- * @typedef { import("../../types").TemplateText } TemplateText
- * @typedef { import("../../types").OpenTemplate } OpenTemplate
- * @typedef { import("../../types").CloseTemplate } CloseTemplate
- * @typedef { import("../../types").AnyPartNode } AnyPartNode
+ * @typedef { import("../../types").BaseNode } BaseNode
+ * @typedef { import("@html-eslint/types").Text } Text
+ * @typedef { import("@html-eslint/types").CommentContent } CommentContent
+ * @typedef { import("@html-eslint/types").Comment } Comment
+ * @typedef { import("@html-eslint/types").AttributeValue } AttributeValue
+ * @typedef { import("@html-eslint/types").AttributeKey } AttributeKey
+ * @typedef { import("@html-eslint/types").TemplateText } TemplateText
+ * @typedef { import("@html-eslint/types").OpenTemplate } OpenTemplate
+ * @typedef { import("@html-eslint/types").CloseTemplate } CloseTemplate
  * @typedef { import("eslint").AST.Range } Range
  * @typedef { import("eslint").AST.SourceLocation } SourceLocation
  * @typedef { import("es-html-parser").AnyToken } AnyToken
-
  */
 
 const { NODE_TYPES } = require("@html-eslint/parser");
@@ -156,7 +155,7 @@ function getLocBetween(before, after) {
 }
 
 /**
- * @param {AnyNode} node
+ * @param {BaseNode} node
  * @returns {node is Tag}
  */
 function isTag(node) {
@@ -164,7 +163,7 @@ function isTag(node) {
 }
 
 /**
- * @param {AnyNode} node
+ * @param {BaseNode} node
  * @returns {node is ScriptTag}
  */
 function isScript(node) {
@@ -172,7 +171,7 @@ function isScript(node) {
 }
 
 /**
- * @param {AnyNode} node
+ * @param {BaseNode} node
  * @returns {node is StyleTag}
  */
 function isStyle(node) {
@@ -180,7 +179,7 @@ function isStyle(node) {
 }
 
 /**
- * @param {AnyNode} node
+ * @param {BaseNode} node
  * @returns {node is Comment}
  */
 function isComment(node) {
@@ -188,7 +187,7 @@ function isComment(node) {
 }
 
 /**
- * @param {AnyNode} node
+ * @param {BaseNode} node
  * @returns {node is Text}
  */
 function isText(node) {
@@ -196,7 +195,7 @@ function isText(node) {
 }
 
 /**
- * @param {AnyNode | Line | TemplateText | OpenTemplate | CloseTemplate } node
+ * @param {BaseNode} node
  * @returns {node is Line}
  */
 function isLine(node) {
@@ -214,7 +213,7 @@ function codeToLines(source) {
 }
 
 /**
- * @param {Exclude<AnyNode, Line>} node
+ * @param {AnyNode} node
  * @param {(node: AnyNode) => boolean} predicate
  * @returns {null | AnyNode}
  */
@@ -224,7 +223,8 @@ function findParent(node, predicate) {
   }
   if (
     node.type === "TaggedTemplateExpression" ||
-    node.type === "TemplateLiteral"
+    node.type === "TemplateLiteral" ||
+    node.type === "TemplateElement"
   ) {
     return null;
   }

package/lib/rules/utils/settings.js

@@ -1,9 +1,9 @@
 /**
  * @typedef {import("../../types").MaybeHTMLSettings} MaybeHTMLSettings
  * @typedef {import("../../types").HTMLSettings} HTMLSettings
- * @typedef {import("../../types").Context} Context
- * @typedef {import("../../types").TaggedTemplateExpression} TaggedTemplateExpression
- * @typedef {import("../../types").TemplateLiteral} TemplateLiteral
+ * @typedef {import("../../types").Context<any[]>} Context
+ * @typedef {import("@html-eslint/types").TaggedTemplateExpression} TaggedTemplateExpression
+ * @typedef {import("@html-eslint/types").TemplateLiteral} TemplateLiteral
  */
 
 const { getSourceCode } = require("../utils/source-code");

package/lib/rules/utils/source-code.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {import("../../types").Context} Context
+ * @typedef {import("../../types").Context<any[]>} Context
  */
 
 /**

package/lib/rules/utils/visitors.js

@@ -1,5 +1,5 @@
 /**
- * @typedef { import("../../types").Context } Context
+ * @typedef { import("../../types").Context<any[]> } Context
  * @typedef { import("../../types").RuleListener } RuleListener
  */
 

package/lib/types/ast.ts

@@ -0,0 +1,17 @@
+import eslint from "eslint";
+
+/**
+ *  This is not a node generated by es-html-parser; it is created by utils's splitToLineNodes.
+ */
+export interface Line extends BaseNode {
+  type: "Line";
+  value: string;
+  hasTemplate: boolean;
+}
+
+export interface BaseNode {
+  parent?: BaseNode | null;
+  type: string;
+  range: eslint.AST.Range;
+  loc: eslint.AST.SourceLocation;
+}

package/lib/types/{rule.d.ts → rule.ts}

@@ -1,5 +1,9 @@
 import eslint from "eslint";
-import * as AST from "./ast";
+import * as AST from "@html-eslint/types";
+import * as estree from "estree";
+import { Line } from "./ast";
+
+type AnyNodeAndLine = AST.AnyNode | Line;
 
 type PostFix<T, S extends string> = {
   [K in keyof T as `${K & string}${S}`]: T[K];
@@ -44,12 +48,36 @@ interface BaseRuleListener {
   TemplateLiteral?: (node: AST.TemplateLiteral) => void;
 }
 
+interface RuleFix {
+  range: eslint.AST.Range;
+  text: string;
+}
+
+export interface RuleFixer {
+  insertTextAfter(nodeOrToken: AnyNodeAndLine, text: string): RuleFix;
+
+  insertTextAfterRange(range: eslint.AST.Range, text: string): RuleFix;
+
+  insertTextBefore(nodeOrToken: AnyNodeAndLine, text: string): RuleFix;
+
+  insertTextBeforeRange(range: eslint.AST.Range, text: string): RuleFix;
+
+  remove(nodeOrToken: AnyNodeAndLine): RuleFix;
+
+  removeRange(range: eslint.AST.Range): RuleFix;
+
+  replaceText(nodeOrToken: AnyNodeAndLine, text: string): RuleFix;
+
+  replaceTextRange(range: eslint.AST.Range, text: string): RuleFix;
+}
+
+type ReportFixFunction = (
+  fixer: RuleFixer
+) => IterableIterator<RuleFix> | readonly RuleFix[] | RuleFix | null;
+
 interface ReportDescriptorOptionsBase {
   data?: { [key: string]: string };
-
-  fix?:
-    | null
-    | ((fixer: RuleFixer) => null | Fix | IterableIterator<Fix> | Fix[]);
+  fix?: null | ReportFixFunction;
 }
 
 type SuggestionDescriptorMessage = { desc: string } | { messageId: string };
@@ -65,19 +93,22 @@ type ReportDescriptor = ReportDescriptorMessage &
   ReportDescriptorOptions;
 type ReportDescriptorMessage = { message: string } | { messageId: string };
 type ReportDescriptorLocation = {
-  node?: BaseNode;
-  loc?: ESLint.AST.SourceLocation;
+  node?: estree.BaseNode;
+  loc?: eslint.AST.SourceLocation;
   line?: number;
   column?: number;
 };
 
-export interface Context extends Omit<ESLint.Rule.RuleContext, "report"> {
+export interface Context<Options extends unknown[]>
+  extends Omit<eslint.Rule.RuleContext, "report"> {
   report(descriptor: ReportDescriptor): void;
+  options: Options;
 }
 
 export type RuleListener = BaseRuleListener &
   PostFix<BaseRuleListener, ":exit">;
 
-export interface RuleModule extends eslint.Rule.RuleModule {
-  create(context: Context): RuleListener;
+export interface RuleModule<Options extends unknown[]> {
+  create(context: Context<Options>): RuleListener;
+  meta: eslint.Rule.RuleMetaData;
 }

package/package.json

@@ -1,17 +1,12 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.35.0",
+  "version": "0.35.2",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
   "license": "MIT",
   "main": "lib/index.js",
-  "types": "types/index.d.ts",
-  "directories": {
-    "lib": "lib",
-    "test": "__tests__",
-    "types": "types"
-  },
+  "types": "types/exports.d.ts",
   "files": [
     "lib",
     "types"
@@ -25,16 +20,13 @@
   },
   "scripts": {
     "test": "jest --coverage",
-    "ts": "tsc",
-    "lint": "eslint",
-    "build": "tsc -p ./tsconfig.build.json"
+    "ts": "tsc --noEmit",
+    "lint": "eslint .",
+    "build": "rimraf types && tsc  --project tsconfig.build.json"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
   },
-  "engines": {
-    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
-  },
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -45,17 +37,18 @@
     "accessibility"
   ],
   "dependencies": {
-    "@html-eslint/template-parser": "^0.35.0",
-    "@html-eslint/template-syntax-parser": "^0.35.0"
+    "@html-eslint/template-parser": "^0.35.2",
+    "@html-eslint/template-syntax-parser": "^0.35.2"
   },
   "devDependencies": {
-    "@html-eslint/parser": "^0.35.0",
+    "@html-eslint/parser": "^0.35.2",
+    "@html-eslint/types": "^0.35.1",
     "@types/eslint": "^9.6.1",
     "@types/estree": "^0.0.47",
-    "es-html-parser": "0.1.0",
-    "eslint": "^9",
+    "es-html-parser": "0.1.1",
+    "eslint": "^9.21.0",
     "espree": "^10.3.0",
     "typescript": "^5.7.2"
   },
-  "gitHead": "2493a6a72eba5e4fca3be33897050a4ea29712dd"
+  "gitHead": "d367b20d5822e66a88aed100f7a3e67bb9e1b2f0"
 }

package/types/exports.d.ts

@@ -0,0 +1,3 @@
+import plugin = require("./index");
+export default plugin;
+//# sourceMappingURL=exports.d.ts.map

package/types/exports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../lib/exports.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,GAAG,QAAQ,SAAS,CAAC,CAAC;AACnC,eAAe,MAAM,CAAC"}