@html-eslint/eslint-plugin 0.9.0-alpha.0 → 0.11.0

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

@@ -1,13 +1,17 @@
-// @ts-check
 /**
- * @typedef {import("../../types").HTMLNode} HTMLNode
+ * @typedef {import("../../types").ElementNode} ElementNode
  * @typedef {import("../../types").AttrNode} AttrNode
+ * @typedef {import("../../types").AnyNode} AnyNode
+ * @typedef {import("../../types").TextNode} TextNode
+ * @typedef {import("../../types").BaseNode} BaseNode
+ * @typedef {import("../../types").TextLineNode} TextLineNode
+ * @typedef {import("../../types").CommentNode} CommentNode
  */
 
 module.exports = {
   /**
    * Find attribute by name in the given node
-   * @param {HTMLNode} node node
+   * @param {ElementNode} node node
    * @param {string} name attribute name
    * @return {AttrNode | void}
    */
@@ -20,7 +24,7 @@ module.exports = {
   },
   /**
    * Checks a node has attribute with the given name or not.
-   * @param {HTMLNode} node node
+   * @param {ElementNode} node node
    * @param {string} name attribute name
    * @return {boolean} `true` if the node has a attribute, otherwise `false`.
    */
@@ -29,10 +33,28 @@ module.exports = {
   },
   /**
    * Checks whether a node's all tokens are on the same line or not.
-   * @param {HTMLNode} node A node to check
+   * @param {ElementNode} 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");
+  },
 };

package/lib/types.d.ts

@@ -1,49 +1,120 @@
-export type RuleCategory = {
-  BEST_PRACTICE: "Best Practice";
-  SEO: "SEO";
-  ACCESSIBILITY: "Accessibility";
-  STYLE: "Style";
-};
+import ESTree from "estree";
+import ESLint from "eslint";
+
+type Fix = ESLint.Rule.Fix;
+type Token = ESLint.AST.Token;
+export type Range = ESLint.AST.Range;
+
+interface RuleListener {
+  [key: string]: (node: ElementNode) => void;
+}
+
+export interface Rule {
+  create(context: Context): RuleListener;
+  meta?: ESLint.Rule.RuleMetaData;
+}
+
+interface RuleFixer {
+  insertTextAfter(nodeOrToken: AnyNode | Token, text: string): Fix;
+
+  insertTextAfterRange(range: Range, text: string): Fix;
+
+  insertTextBefore(nodeOrToken: AnyNode | Token, text: string): Fix;
+
+  insertTextBeforeRange(range: Range, text: string): Fix;
+
+  remove(nodeOrToken: AnyNode | Token): Fix;
+
+  removeRange(range: Range): Fix;
+
+  replaceText(nodeOrToken: AnyNode | 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[]);
+}
 
-export type NodeTypes = {
-  PROGRAM: "Program";
-  TEXT: "text";
-  TITLE: "Title";
-  PRE: "Pre";
-  MENU: "Menu";
-  OL: "Ol";
-  UL: "Ul";
-  SCRIPT: "Script";
-  XMP: "Xmp";
-  META: "Meta";
-  STYLE: "Style";
+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;
 };
 
-interface BaseNode {
+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;
-  range: [number, number];
   loc: {
-    end: {
-      line: number;
-      column: number;
-    };
-    start: {
-      line: number;
-      column: number;
-    };
+    start: ESTree.Position;
+    end: ESTree.Position;
   };
+  type?: string;
+}
+
+export interface TagNode extends BaseNode {
+  type: undefined;
 }
 
-export interface HTMLNode extends BaseNode {
-  childNodes?: HTMLNode[];
-  startTag?: BaseNode;
-  endTag?: BaseNode;
+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;
-  attrs?: AttrNode[];
+  tagName: string;
+  attrs: AttrNode[];
+  childNodes: ElementNode[];
+  startTag?: TagNode;
+  endTag?: TagNode;
 }
 
 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.9.0-alpha.0",
+  "version": "0.11.0",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -21,7 +21,8 @@
     "url": "git+https://github.com/yeonjuan/html-eslint.git"
   },
   "scripts": {
-    "test": "jest --coverage"
+    "test": "jest --coverage",
+    "check:ts": "tsc"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
@@ -39,7 +40,10 @@
     "accessibility"
   ],
   "devDependencies": {
-    "@html-eslint/parser": "^0.9.0-alpha.0"
+    "@html-eslint/parser": "^0.11.0",
+    "@types/eslint": "^7.2.10",
+    "@types/estree": "^0.0.47",
+    "typescript": "^4.2.4"
   },
-  "gitHead": "442c5d402ce891b088b1548fe8a27fe9fadc91c3"
+  "gitHead": "a3873ecefae3b9306a5e98985cf4ccdbde95299a"
 }