@html-eslint/eslint-plugin 0.35.0 → 0.35.1

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.d.ts

@@ -1,213 +1,17 @@
-import * as Parser from "es-html-parser";
 import eslint from "eslint";
-import * as estree from "estree";
-
-export interface Document extends Parser.DocumentNode {
-  parent: null;
-  children: Array<Tag | Text | Comment | Doctype | ScriptTag | StyleTag>;
-}
-
-export interface Doctype extends Parser.DoctypeNode {
-  parent: Document | Tag;
-  open: DoctypeOpen;
-  close: DoctypeClose;
-  attributes: Array<DoctypeAttribute>;
-}
-
-export interface DoctypeOpen extends Parser.DoctypeOpenNode {
-  parent: Doctype;
-}
-
-export interface DoctypeClose extends Parser.DoctypeCloseNode {
-  parent: Doctype;
-}
-
-export interface DoctypeAttribute extends Parser.DoctypeAttributeNode {
-  parent: Doctype;
-}
-
-export interface Comment extends Parser.CommentNode {
-  parent: Tag | Document;
-  open: CommentOpen;
-  close: CommentClose;
-  value: CommentContent;
-}
-
-export interface CommentOpen extends Parser.CommentOpenNode {
-  parent: Comment;
-}
-
-export interface CommentClose extends Parser.CommentCloseNode {
-  parent: Comment;
-}
-
-export interface CommentContent extends Parser.CommentContentNode {
-  parent: Comment;
-}
-
-export interface Tag extends Parser.TagNode {
-  parent: Document | Tag;
-  openStart: OpenTagStart;
-  openEnd: OpenTagEnd;
-  attributes: Array<Attribute>;
-  close?: CloseTag;
-  children: Array<Tag | Text | StyleTag | ScriptTag>;
-}
-
-export interface OpenTagStart extends Parser.OpenTagStartNode {
-  parent: Tag;
-}
-
-export interface OpenTagEnd extends Parser.OpenTagEndNode {
-  parent: Tag;
-}
-
-export interface CloseTag extends Parser.CloseTagNode {
-  parent: Tag;
-}
-
-export interface ScriptTag extends Parser.ScriptTagNode {
-  parent: Document | Tag;
-  attributes: Array<Attribute>;
-  openStart: OpenScriptTagStart;
-  openEnd: OpenScriptTagEnd;
-  value?: ScriptTagContent;
-}
-
-export interface OpenScriptTagStart extends Parser.OpenScriptTagStartNode {
-  parent: ScriptTag;
-}
-
-export interface OpenScriptTagEnd extends Parser.OpenScriptTagEndNode {
-  parent: ScriptTag;
-}
-
-export interface CloseScriptTag extends Parser.CloseScriptTagNode {
-  parent: ScriptTag;
-}
-
-export interface ScriptTagContent extends Parser.ScriptTagContentNode {
-  parent: ScriptTag;
-}
-
-export interface StyleTag extends Parser.StyleTagNode {
-  parent: Document | Tag;
-  attributes: Array<Attribute>;
-  openStart: OpenStyleTagStart;
-  openEnd: OpenStyleTagEnd;
-  value?: StyleTagContent;
-}
-
-export interface OpenStyleTagStart extends Parser.OpenStyleTagStartNode {
-  parent: StyleTag;
-}
-
-export interface OpenStyleTagEnd extends Parser.OpenStyleTagEndNode {
-  parent: StyleTag;
-}
-
-export interface CloseStyleTag extends Parser.CloseStyleTagNode {
-  parent: StyleTag;
-}
-
-export interface StyleTagContent extends Parser.StyleTagContentNode {
-  parent: StyleTag;
-}
-
-export interface Attribute extends Parser.AttributeNode {
-  parent: Tag;
-  key: AttributeKey;
-  value?: AttributeValue;
-  startWrapper?: AttributeValueWrapperStart;
-  endWrapper?: AttributeValueWrapperEnd;
-}
-
-export interface AttributeKey extends Parser.AttributeKeyNode {
-  parent: Attribute;
-}
-
-export interface AttributeValue extends Parser.AttributeValueNode {
-  parent: Attribute;
-}
-
-export interface AttributeValueWrapperStart
-  extends Parser.AttributeValueWrapperStartNode {
-  parent: Attribute;
-}
-
-export interface AttributeValueWrapperEnd
-  extends Parser.AttributeValueWrapperEndNode {
-  parent: Attribute;
-}
-
-export interface Text extends Parser.TextNode {
-  parent: Document | Tag;
-}
 
 /**
  *  This is not a node generated by es-html-parser; it is created by utils's splitToLineNodes.
  */
-export interface Line {
+export interface Line extends BaseNode {
   type: "Line";
   value: string;
   hasTemplate: boolean;
-  range: eslint.AST.Range;
-  loc: eslint.AST.SourceLocation;
 }
 
-export interface TaggedTemplateExpression
-  extends estree.TaggedTemplateExpression {
-  parent: estree.Node | null;
-  loc: eslint.AST.SourceLocation;
+export interface BaseNode {
+  parent?: BaseNode | null;
+  type: string;
   range: eslint.AST.Range;
-  quasi: TemplateLiteral;
-}
-
-export interface TemplateLiteral extends estree.TemplateLiteral {
-  parent: estree.Node | null;
   loc: eslint.AST.SourceLocation;
-  range: eslint.AST.Range;
 }
-
-export type TemplateText = Text["parts"][number];
-
-export type OpenTemplate = Exclude<Parser.TemplateNode<any>["open"], undefined>;
-export type CloseTemplate = Exclude<
-  Parser.TemplateNode<any>["close"],
-  undefined
->;
-export type AnyPartNode = Parser.PartNode<Parser.NodeTypes>;
-
-export type AnyNode =
-  | Document
-  | Doctype
-  | DoctypeOpen
-  | DoctypeClose
-  | DoctypeAttribute
-  | Comment
-  | CommentOpen
-  | CommentClose
-  | CommentContent
-  | Tag
-  | OpenTagStart
-  | OpenTagEnd
-  | CloseTag
-  | ScriptTag
-  | OpenScriptTagStart
-  | OpenScriptTagEnd
-  | ScriptTagContent
-  | CloseScriptTag
-  | StyleTag
-  | OpenStyleTagStart
-  | OpenStyleTagEnd
-  | StyleTagContent
-  | CloseStyleTag
-  | Attribute
-  | AttributeKey
-  | AttributeValue
-  | AttributeValueWrapperEnd
-  | AttributeValueWrapperStart
-  | Text
-  | Line
-  | TaggedTemplateExpression
-  | TemplateLiteral;

package/lib/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./ast";
 export * from "./rule";
 export * from "./settings";
+export * from "./ast";