@html-eslint/eslint-plugin 0.19.1 → 0.21.0

package/lib/types.d.ts

@@ -2,253 +2,269 @@ import ESTree from "estree";
 import ESLint from "eslint";
 import * as ESHtml from "es-html-parser";
 
-type Fix = ESLint.Rule.Fix;
-type Token = ESLint.AST.Token;
-
-export type AnyNode = ESHtml.AnyNode | LineNode;
-
-export type Range = ESLint.AST.Range;
-
-export type Location = ESLint.AST.SourceLocation;
-
-export interface BaseNode {
-  range: [number, number];
-  loc: {
-    start: ESTree.Position;
-    end: ESTree.Position;
+declare global {
+  type Fix = ESLint.Rule.Fix;
+  type Token = ESLint.AST.Token;
+
+  type AnyNode = ESHtml.AnyNode | LineNode;
+
+  type Range = ESLint.AST.Range;
+
+  type Location = ESLint.AST.SourceLocation;
+
+  interface BaseNode {
+    range: [number, number];
+    loc: {
+      start: ESTree.Position;
+      end: ESTree.Position;
+    };
+  }
+
+  interface ProgramNode extends Omit<ESHtml.DocumentNode, "type" | "children"> {
+    type: "Program";
+    body: ESHtml.DocumentNode["children"];
+  }
+
+  interface AttributeKeyNode extends ESHtml.AttributeKeyNode {
+    parent: AttributeNode;
+  }
+
+  interface TextNode extends ESHtml.TextNode {
+    parent: TagNode;
+  }
+
+  interface TagNode extends ESHtml.TagNode {
+    attributes: AttributeNode[];
+    parent: TagNode | ProgramNode;
+    openStart: OpenTagStartNode;
+    openEnd: OpenTagEndNode;
+    close: CloseTagNode;
+    children: Array<
+      TextNode | TagNode | ScriptTagNode | StyleTagNode | CommentNode
+    >;
+  }
+
+  interface OpenTagStartNode extends ESHtml.OpenTagStartNode {
+    parent: TagNode;
+  }
+
+  interface OpenTagEndNode extends ESHtml.OpenTagEndNode {
+    parent: TagNode;
+  }
+
+  interface CloseTagNode extends ESHtml.CloseTagNode {
+    parent: TagNode;
+  }
+
+  interface AttributeNode extends ESHtml.AttributeNode {
+    key: AttributeKeyNode;
+    value?: AttributeValueNode;
+    parent: TagNode | StyleTagNode | ScriptTagNode;
+  }
+
+  interface AttributeValueNode extends ESHtml.AttributeValueNode {
+    parent: AttributeNode;
+  }
+
+  interface AttributeValueWrapperEndNode
+    extends ESHtml.AttributeValueWrapperEndNode {
+    parent: AttributeNode;
+  }
+
+  interface AttributeValueWrapperStartNode
+    extends ESHtml.AttributeValueWrapperStartNode {
+    parent: AttributeNode;
+  }
+
+  interface ScriptTagNode extends ESHtml.ScriptTagNode {
+    attributes: AttributeNode[];
+    parent: ProgramNode | TagNode;
+    openStart: OpenScriptTagStartNode;
+    openEnd: OpenScriptTagEndNode;
+  }
+
+  interface OpenScriptTagStartNode extends ESHtml.OpenScriptTagStartNode {
+    parent: ScriptTagNode;
+  }
+
+  interface CloseScriptTagNode extends ESHtml.CloseScriptTagNode {
+    parent: ScriptTagNode;
+  }
+
+  interface OpenScriptTagEndNode extends ESHtml.OpenScriptTagEndNode {
+    parent: ScriptTagNode;
+  }
+
+  interface ScriptTagContentNode extends ESHtml.ScriptTagContentNode {
+    parent: ScriptTagNode;
+  }
+
+  interface StyleTagNode extends ESHtml.StyleTagNode {
+    attributes: AttributeNode[];
+    parent: TagNode | ProgramNode;
+    openStart: OpenStyleTagStartNode;
+    openEnd: OpenStyleTagEndNode;
+  }
+
+  interface OpenStyleTagStartNode extends ESHtml.OpenStyleTagStartNode {
+    parent: StyleTagNode;
+  }
+
+  interface OpenStyleTagEndNode extends ESHtml.OpenStyleTagEndNode {
+    parent: StyleTagNode;
+  }
+
+  interface StyleTagContentNode extends ESHtml.StyleTagContentNode {
+    parent: StyleTagNode;
+  }
+
+  interface CloseStyleTagNode extends ESHtml.CloseStyleTagNode {
+    parent: StyleTagNode;
+  }
+
+  interface CommentNode extends ESHtml.CommentNode {
+    parent: ProgramNode | TagNode;
+  }
+
+  interface CommentOpenNode extends ESHtml.CommentOpenNode {
+    parent: CommentNode;
+  }
+
+  interface CommentCloseNode extends ESHtml.CommentCloseNode {
+    parent: CommentNode;
+  }
+
+  interface CommentContentNode extends ESHtml.CommentContentNode {
+    parent: CommentNode;
+  }
+
+  interface DoctypeNode extends ESHtml.DoctypeNode {
+    parent: ProgramNode;
+  }
+
+  interface DoctypeOpenNode extends ESHtml.DoctypeOpenNode {
+    parent: DoctypeNode;
+  }
+
+  interface DoctypeCloseNode extends ESHtml.DoctypeCloseNode {
+    parent: DoctypeNode;
+  }
+
+  interface DoctypeAttributeNode extends ESHtml.DoctypeAttributeNode {
+    parent: DoctypeNode;
+  }
+
+  interface DoctypeAttributeValueNode extends ESHtml.DoctypeAttributeValueNode {
+    parent: DoctypeNode;
+  }
+
+  interface DoctypeAttributeWrapperStart
+    extends ESHtml.DoctypeAttributeWrapperStartNode {
+    parent: DoctypeNode;
+  }
+
+  interface DoctypeAttributeWrapperEnd
+    extends ESHtml.DoctypeAttributeWrapperEndNode {
+    parent: DoctypeNode;
+  }
+
+  interface LineNode extends BaseNode {
+    type: "Line";
+    value: string;
+  }
+
+  interface RuleListener {
+    Program?: (node: ProgramNode) => void;
+    AttributeKey?: (node: AttributeKeyNode) => void;
+    Text?: (node: TextNode) => void;
+    Tag?: (node: TagNode) => void;
+    OpenTagStart?: (node: OpenTagStartNode) => void;
+    OpenTagEnd?: (node: OpenTagEndNode) => void;
+    CloseTag?: (node: CloseTagNode) => void;
+    Attribute?: (node: AttributeNode) => void;
+    AttributeValue?: (node: AttributeValueNode) => void;
+    AttributeValueWrapperEnd?: (node: AttributeValueWrapperEndNode) => void;
+    AttributeValueWrapperStart?: (node: AttributeValueWrapperStartNode) => void;
+    ScriptTag?: (node: ScriptTagNode) => void;
+    OpenScriptTagStart?: (node: OpenScriptTagStartNode) => void;
+    CloseScriptTag?: (node: CloseScriptTagNode) => void;
+    OpenScriptTagEnd?: (node: OpenScriptTagEndNode) => void;
+    ScriptTagContent?: (node: ScriptTagContentNode) => void;
+    StyleTag?: (node: StyleTagNode) => void;
+    OpenStyleTagStart?: (node: OpenStyleTagStartNode) => void;
+    OpenStyleTagEnd?: (node: OpenStyleTagEndNode) => void;
+    StyleTagContent?: (node: StyleTagContentNode) => void;
+    CloseStyleTag?: (node: CloseStyleTagNode) => void;
+    Comment?: (node: CommentNode) => void;
+    CommentOpen?: (node: CommentOpenNode) => void;
+    CommentClose?: (node: CommentCloseNode) => void;
+    CommentContent?: (node: CommentContentNode) => void;
+    Doctype?: (node: DoctypeNode) => void;
+    DoctypeOpen: (node: DoctypeOpenNode) => void;
+    DoctypeClose?: (node: DoctypeCloseNode) => void;
+    DoctypeAttribute?: (node: DoctypeAttributeNode) => void;
+    DoctypeAttributeValue?: (node: DoctypeAttributeValueNode) => void;
+    DoctypeAttributeWrapperStart?: (node: DoctypeAttributeWrapperStart) => void;
+    DoctypeAttributeWrapperEnd?: (node: DoctypeAttributeWrapperEnd) => void;
+  }
+
+  interface Rule {
+    create(context: Context): RuleListener;
+    meta?: ESLint.Rule.RuleMetaData;
+  }
+
+  interface RuleFixer {
+    insertTextAfter(nodeOrToken: BaseNode | Token, text: string): Fix;
+
+    insertTextAfterRange(range: Range, text: string): Fix;
+
+    insertTextBefore(nodeOrToken: BaseNode | Token, text: string): Fix;
+
+    insertTextBeforeRange(range: Range, text: string): Fix;
+
+    remove(nodeOrToken: BaseNode | Token): Fix;
+
+    removeRange(range: Range): Fix;
+
+    replaceText(nodeOrToken: BaseNode | Token, text: string): Fix;
+
+    replaceTextRange(range: Range, text: string): Fix;
+  }
+
+  interface ReportDescriptorOptionsBase {
+    data?: { [key: string]: string };
+
+    fix?:
+      | null
+      | ((fixer: RuleFixer) => null | Fix | IterableIterator<Fix> | Fix[]);
+  }
+
+  type SuggestionDescriptorMessage = { desc: string } | { messageId: string };
+  type SuggestionReportDescriptor = SuggestionDescriptorMessage &
+    ReportDescriptorOptionsBase;
+
+  interface ReportDescriptorOptions extends ReportDescriptorOptionsBase {
+    suggest?: SuggestionReportDescriptor[] | null;
+  }
+
+  type ReportDescriptor = ReportDescriptorMessage &
+    ReportDescriptorLocation &
+    ReportDescriptorOptions;
+  type ReportDescriptorMessage = { message: string } | { messageId: string };
+  type ReportDescriptorLocation = {
+    node?: BaseNode;
+    loc?: ESLint.AST.SourceLocation;
+    line?: number;
+    column?: number;
   };
-}
-
-export interface ProgramNode
-  extends Omit<ESHtml.DocumentNode, "type" | "children"> {
-  type: "Program";
-  body: ESHtml.DocumentNode["children"];
-}
-
-export interface AttributeKeyNode extends ESHtml.AttributeKeyNode {
-  parent: AttributeNode;
-}
-
-export interface TextNode extends ESHtml.TextNode {
-  parent: TagNode;
-}
-
-export interface TagNode extends ESHtml.TagNode {
-  parent: TagNode | ProgramNode;
-  openStart: OpenTagStartNode;
-  close: CloseTagNode;
-  children: Array<
-    TextNode | TagNode | ScriptTagNode | StyleTagNode | CommentNode
-  >;
-}
-
-export interface OpenTagStartNode extends ESHtml.OpenTagStartNode {
-  parent: TagNode;
-}
-
-export interface OpenTagEndNode extends ESHtml.OpenTagEndNode {
-  parent: TagNode;
-}
-
-export interface CloseTagNode extends ESHtml.CloseTagNode {
-  parent: TagNode;
-}
-
-export interface AttributeNode extends ESHtml.AttributeNode {
-  parent: TagNode;
-}
-
-export interface AttributeValueNode extends ESHtml.AttributeValueNode {
-  parent: AttributeNode;
-}
-
-export interface AttributeValueWrapperEndNode
-  extends ESHtml.AttributeValueWrapperEndNode {
-  parent: AttributeNode;
-}
-
-export interface AttributeValueWrapperStartNode
-  extends ESHtml.AttributeValueWrapperStartNode {
-  parent: AttributeNode;
-}
-
-export interface ScriptTagNode extends ESHtml.ScriptTagNode {
-  parent: ProgramNode | TagNode;
-}
-
-export interface OpenScriptTagStartNode extends ESHtml.OpenScriptTagStartNode {
-  parent: ScriptTagNode;
-}
-
-export interface CloseScriptTagNode extends ESHtml.CloseScriptTagNode {
-  parent: ScriptTagNode;
-}
-
-export interface OpenScriptTagEndNode extends ESHtml.OpenScriptTagEndNode {
-  parent: ScriptTagNode;
-}
-
-export interface ScriptTagContentNode extends ESHtml.ScriptTagContentNode {
-  parent: ScriptTagNode;
-}
-
-export interface StyleTagNode extends ESHtml.StyleTagNode {
-  parent: TagNode | ProgramNode;
-}
-
-export interface OpenStyleTagStartNode extends ESHtml.OpenStyleTagStartNode {
-  parent: StyleTagNode;
-}
-
-export interface OpenStyleTagEndNode extends ESHtml.OpenStyleTagEndNode {
-  parent: StyleTagNode;
-}
-
-export interface StyleTagContentNode extends ESHtml.StyleTagContentNode {
-  parent: StyleTagNode;
-}
 
-export interface CloseStyleTagNode extends ESHtml.CloseStyleTagNode {
-  parent: StyleTagNode;
-}
-
-export interface CommentNode extends ESHtml.CommentNode {
-  parent: ProgramNode | TagNode;
-}
-
-export interface CommentOpenNode extends ESHtml.CommentOpenNode {
-  parent: CommentNode;
-}
-
-export interface CommentCloseNode extends ESHtml.CommentCloseNode {
-  parent: CommentNode;
-}
-
-export interface CommentContentNode extends ESHtml.CommentContentNode {
-  parent: CommentNode;
-}
-
-export interface DoctypeNode extends ESHtml.DoctypeNode {
-  parent: ProgramNode;
-}
-
-export interface DoctypeOpenNode extends ESHtml.DoctypeOpenNode {
-  parent: DoctypeNode;
-}
-
-export interface DoctypeCloseNode extends ESHtml.DoctypeCloseNode {
-  parent: DoctypeNode;
-}
-
-export interface DoctypeAttributeNode extends ESHtml.DoctypeAttributeNode {
-  parent: DoctypeNode;
-}
-
-export interface DoctypeAttributeValueNode
-  extends ESHtml.DoctypeAttributeValueNode {
-  parent: DoctypeNode;
-}
-
-export interface DoctypeAttributeWrapperStart
-  extends ESHtml.DoctypeAttributeWrapperStartNode {
-  parent: DoctypeNode;
-}
-
-export interface DoctypeAttributeWrapperEnd
-  extends ESHtml.DoctypeAttributeWrapperEndNode {
-  parent: DoctypeNode;
-}
-
-export interface LineNode extends BaseNode {
-  type: "Line";
-  value: string;
-}
-
-interface RuleListener {
-  Program?: (node: ProgramNode) => void;
-  AttributeKey?: (node: AttributeKeyNode) => void;
-  Text?: (node: TextNode) => void;
-  Tag?: (node: TagNode) => void;
-  OpenTagStart?: (node: OpenTagStartNode) => void;
-  OpenTagEnd?: (node: OpenTagEndNode) => void;
-  CloseTag?: (node: CloseTagNode) => void;
-  Attribute?: (node: AttributeNode) => void;
-  AttributeValue?: (node: AttributeValueNode) => void;
-  AttributeValueWrapperEnd?: (node: AttributeValueWrapperEndNode) => void;
-  AttributeValueWrapperStart?: (node: AttributeValueWrapperStartNode) => void;
-  ScriptTag?: (node: ScriptTagNode) => void;
-  OpenScriptTagStart?: (node: OpenScriptTagStartNode) => void;
-  CloseScriptTag?: (node: CloseScriptTagNode) => void;
-  OpenScriptTagEnd?: (node: OpenScriptTagEndNode) => void;
-  ScriptTagContent?: (node: ScriptTagContentNode) => void;
-  StyleTag?: (node: StyleTagNode) => void;
-  OpenStyleTagStart?: (node: OpenStyleTagStartNode) => void;
-  OpenStyleTagEnd?: (node: OpenStyleTagEndNode) => void;
-  StyleTagContent?: (node: StyleTagContentNode) => void;
-  CloseStyleTag?: (node: CloseStyleTagNode) => void;
-  Comment?: (node: CommentNode) => void;
-  CommentOpen?: (node: CommentOpenNode) => void;
-  CommentClose?: (node: CommentCloseNode) => void;
-  CommentContent?: (node: CommentContentNode) => void;
-  Doctype?: (node: DoctypeNode) => void;
-  DoctypeOpen: (node: DoctypeOpenNode) => void;
-  DoctypeClose?: (node: DoctypeCloseNode) => void;
-  DoctypeAttribute?: (node: DoctypeAttributeNode) => void;
-  DoctypeAttributeValue?: (node: DoctypeAttributeValueNode) => void;
-  DoctypeAttributeWrapperStart?: (node: DoctypeAttributeWrapperStart) => void;
-  DoctypeAttributeWrapperEnd?: (node: DoctypeAttributeWrapperEnd) => void;
-}
-
-export interface Rule {
-  create(context: Context): RuleListener;
-  meta?: ESLint.Rule.RuleMetaData;
-}
-
-interface RuleFixer {
-  insertTextAfter(nodeOrToken: BaseNode | Token, text: string): Fix;
-
-  insertTextAfterRange(range: Range, text: string): Fix;
-
-  insertTextBefore(nodeOrToken: BaseNode | Token, text: string): Fix;
-
-  insertTextBeforeRange(range: Range, text: string): Fix;
-
-  remove(nodeOrToken: BaseNode | Token): Fix;
-
-  removeRange(range: Range): Fix;
-
-  replaceText(nodeOrToken: BaseNode | Token, text: string): Fix;
-
-  replaceTextRange(range: Range, text: string): Fix;
-}
-
-interface ReportDescriptorOptionsBase {
-  data?: { [key: string]: string };
-
-  fix?:
-    | null
-    | ((fixer: RuleFixer) => null | Fix | IterableIterator<Fix> | Fix[]);
-}
-
-type SuggestionDescriptorMessage = { desc: string } | { messageId: string };
-type SuggestionReportDescriptor = SuggestionDescriptorMessage &
-  ReportDescriptorOptionsBase;
-
-interface ReportDescriptorOptions extends ReportDescriptorOptionsBase {
-  suggest?: SuggestionReportDescriptor[] | null;
-}
+  interface Context extends Omit<ESLint.Rule.RuleContext, "report"> {
+    report(descriptor: ReportDescriptor): void;
+  }
 
-type ReportDescriptor = ReportDescriptorMessage &
-  ReportDescriptorLocation &
-  ReportDescriptorOptions;
-type ReportDescriptorMessage = { message: string } | { messageId: string };
-type ReportDescriptorLocation = {
-  node?: BaseNode;
-  loc?: ESLint.AST.SourceLocation;
-  line?: number;
-  column?: number;
-};
-
-export interface Context extends Omit<ESLint.Rule.RuleContext, "report"> {
-  report(descriptor: ReportDescriptor): void;
+  type ChildType<T extends BaseNode> = T extends ProgramNode
+    ? T["body"][number]
+    : T extends TagNode
+    ? T["children"][number]
+    : never;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.19.1",
+  "version": "0.21.0",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -22,13 +22,14 @@
   },
   "scripts": {
     "test": "jest --coverage",
-    "check:ts": "tsc"
+    "ts": "tsc",
+    "lint": "eslint . --ext .js"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
   },
   "engines": {
-    "node": ">=8.10.0"
+    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
   },
   "keywords": [
     "eslint",
@@ -40,11 +41,11 @@
     "accessibility"
   ],
   "devDependencies": {
-    "@html-eslint/parser": "^0.19.1",
+    "@html-eslint/parser": "^0.21.0",
     "@types/eslint": "^7.2.10",
     "@types/estree": "^0.0.47",
     "es-html-parser": "^0.0.8",
     "typescript": "^4.4.4"
   },
-  "gitHead": "f016ce5084fa1e348a199cd9cc27079a587e60d4"
+  "gitHead": "494441cc7bef7b56ece42b07406c0b2f0ee01d59"
 }

package/lib/constants/node-types.js

@@ -1,13 +0,0 @@
-module.exports = {
-  PROGRAM: "Program",
-  TEXT: "text",
-  TITLE: "Title",
-  PRE: "Pre",
-  MENU: "Menu",
-  OL: "Ol",
-  UL: "Ul",
-  SCRIPT: "Script",
-  XMP: "Xmp",
-  STYLE: "Style",
-  META: "Meta",
-};

package/lib/rules/utils/index.js

@@ -1,7 +0,0 @@
-const NodeUtils = require("./node-utils");
-const NamingUtils = require("./naming-utils");
-
-module.exports = {
-  NodeUtils,
-  NamingUtils,
-};

package/lib/rules/utils/node-utils.js

@@ -1,112 +0,0 @@
-/**
- * @typedef {import("es-html-parser").TagNode} TagNode
- * @typedef {import("es-html-parser").AnyNode} AnyNode
- * @typedef {import("es-html-parser").TextNode} TextNode
- * @typedef {import("es-html-parser").AttributeNode} AttributeNode
- * @typedef {import("../../types").LineNode} LineNode
- * @typedef {import("../../types").CommentContentNode} CommentContentNode
- * @typedef {import("../../types").BaseNode} BaseNode
- * @typedef {import("../../types").Location} Location
- */
-
-module.exports = {
-  /*
-   * @param {TagNode} node
-   * @param {string} name
-   * @returns {AttributeNode | undefined}
-   */
-  findAttr(node, name) {
-    return node.attributes.find(
-      (attr) => attr.key && attr.key.value.toLowerCase() === name.toLowerCase()
-    );
-  },
-  /**
-   * Checks a node has attribute with the given name or not.
-   * @param {TagNode} node node
-   * @param {string} name attribute name
-   * @return {boolean} `true` if the node has a attribute, otherwise `false`.
-   */
-  hasAttr(node, name) {
-    return (
-      !!node &&
-      (node.attributes || []).some(
-        (attr) => attr.key && attr.key.value === name
-      )
-    );
-  },
-  /**
-   * Checks whether a node's all tokens are on the same line or not.
-   * @param {AnyNode} node A node to check
-   * @returns {boolean} `true` if a node's tokens are on the same line, otherwise `false`.
-   */
-  isNodeTokensOnSameLine(node) {
-    return node.loc.start.line === node.loc.end.line;
-  },
-
-  /**
-   * Checks whether a node is a TextNode or not.
-   * @param {Object} node A node to check
-   * @returns {node is TextNode} `true` if a node is `TextNode`, otherwise `false`.
-   */
-  isTextNode(node) {
-    return !!(node && node.type === "text" && typeof node.value === "string");
-  },
-
-  /**
-   * Checks whether a node is a CommentNode or not.
-   * @param {Object} node A node to check
-   * @returns {node is CommentNode} `true` if a node is `CommentNode`, otherwise `false`.
-   */
-  isCommentNode(node) {
-    return !!(node && node.type === "comment");
-  },
-
-  /**
-   *
-   * @param {TextNode | CommentContentNode} node
-   * @returns {LineNode[]}
-   */
-  splitToLineNodes(node) {
-    let start = node.range[0];
-    let line = node.loc.start.line;
-    const startCol = node.loc.start.column;
-
-    return node.value.split("\n").map((value, index) => {
-      const columnStart = index === 0 ? startCol : 0;
-      /**
-       * @type {LineNode}
-       */
-      const lineNode = {
-        type: "Line",
-        value,
-        range: [start, start + value.length],
-        loc: {
-          start: {
-            line,
-            column: columnStart,
-          },
-          end: {
-            line,
-            column: columnStart + value.length,
-          },
-        },
-      };
-
-      start += value.length + 1;
-      line += 1;
-      return lineNode;
-    });
-  },
-  /**
-   * Get location between two nodes.
-   * @param {BaseNode} before A node placed in before
-   * @param {BaseNode} after A node placed in after
-   * @returns {Location} location between two nodes.
-   */
-  getLocBetween(before, after) {
-    return {
-      start: before.loc.end,
-      end: after.loc.start,
-    };
-  },
-};