@html-eslint/eslint-plugin 0.13.2 → 0.14.1

package/lib/types.d.ts

@@ -1,12 +1,200 @@
 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 interface BaseNode {
+  range: [number, number];
+  loc: {
+    start: ESTree.Position;
+    end: ESTree.Position;
+  };
+}
+
+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 {
-  [key: string]: (node: ElementNode) => void;
+  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 {
@@ -15,19 +203,19 @@ export interface Rule {
 }
 
 interface RuleFixer {
-  insertTextAfter(nodeOrToken: AnyNode | Token, text: string): Fix;
+  insertTextAfter(nodeOrToken: BaseNode | Token, text: string): Fix;
 
   insertTextAfterRange(range: Range, text: string): Fix;
 
-  insertTextBefore(nodeOrToken: AnyNode | Token, text: string): Fix;
+  insertTextBefore(nodeOrToken: BaseNode | Token, text: string): Fix;
 
   insertTextBeforeRange(range: Range, text: string): Fix;
 
-  remove(nodeOrToken: AnyNode | Token): Fix;
+  remove(nodeOrToken: BaseNode | Token): Fix;
 
   removeRange(range: Range): Fix;
 
-  replaceText(nodeOrToken: AnyNode | Token, text: string): Fix;
+  replaceText(nodeOrToken: BaseNode | Token, text: string): Fix;
 
   replaceTextRange(range: Range, text: string): Fix;
 }
@@ -62,60 +250,3 @@ type ReportDescriptorLocation = {
 export interface Context extends Omit<ESLint.Rule.RuleContext, "report"> {
   report(descriptor: ReportDescriptor): void;
 }
-
-export interface BaseNode {
-  parent?: null | AnyNode;
-  range: [number, number];
-  start: number;
-  end: number;
-  loc: {
-    start: ESTree.Position;
-    end: ESTree.Position;
-  };
-  type?: string;
-}
-
-export interface TagNode extends BaseNode {
-  type: undefined;
-}
-
-export interface TextLineNode extends BaseNode {
-  textLine: string;
-}
-
-export interface TextNode extends BaseNode {
-  type: "text";
-  value: string;
-  lineNodes: TextLineNode[];
-}
-
-export interface ElementNode extends BaseNode {
-  type: string;
-  tagName: string;
-  attrs: AttrNode[];
-  childNodes: ElementNode[];
-  startTag?: TagNode;
-  endTag?: TagNode;
-  namespaceURI?: string;
-}
-
-export interface AttrNode extends BaseNode {
-  name: string;
-  value: string;
-}
-
-export interface CommentNode extends BaseNode {
-  type: "comment";
-  value: string;
-  startTag?: TagNode;
-  endTag?: TagNode;
-  lineNodes: TextLineNode[];
-}
-
-export type AnyNode =
-  | AttrNode
-  | ElementNode
-  | TextNode
-  | TextLineNode
-  | TagNode
-  | CommentNode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.13.2",
+  "version": "0.14.1",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -40,10 +40,11 @@
     "accessibility"
   ],
   "devDependencies": {
-    "@html-eslint/parser": "^0.13.2",
+    "@html-eslint/parser": "^0.14.0",
     "@types/eslint": "^7.2.10",
     "@types/estree": "^0.0.47",
+    "es-html-parser": "^0.0.7",
     "typescript": "^4.4.4"
   },
-  "gitHead": "3f1599284d5725db38e0984ecdcd283a76a530fa"
+  "gitHead": "0fd16ae07553f8d73840ba2e2c07cc488233da05"
 }