@html-eslint/eslint-plugin 0.22.0 → 0.23.0

package/lib/index.js

@@ -1,7 +1,28 @@
 const rules = require("./rules");
 const recommended = require("./configs/recommended");
+const parser = require("@html-eslint/parser");
 
-module.exports.rules = rules;
-module.exports.configs = {
-  recommended,
+/**
+ * @type {{configs: {recommended: typeof recommended,"flat/recommended": import("eslint").Linter.FlatConfig , rules: typeof rules}}}
+ */
+const plugin = {
+  // @ts-ignore
+  configs: {
+    recommended,
+  },
+  rules,
 };
+
+Object.assign(plugin.configs, {
+  "flat/recommended": {
+    plugins: {
+      "@html-eslint": plugin,
+    },
+    languageOptions: {
+      parser,
+    },
+    rules: recommended.rules,
+  },
+});
+
+module.exports = plugin;

package/lib/rules/element-newline.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").ProgramNode } ProgramNode
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").BaseNode } BaseNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -6,7 +13,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {
@@ -45,7 +52,7 @@ module.exports = {
     const skipTags = option.skip;
     let skipTagCount = 0;
     /**
-     * @param {ChildType<TagNode | ProgramNode>[]} siblings
+     * @param {import("../types").ChildType<TagNode | ProgramNode>[]} siblings
      */
     function checkSiblings(siblings) {
       siblings
@@ -70,7 +77,7 @@ module.exports = {
 
     /**
      * @param {TagNode} node
-     * @param {ChildType<TagNode>[]} children
+     * @param {import("../types").ChildType<TagNode>[]} children
      */
     function checkChild(node, children) {
       const targetChildren = children.filter((n) => n.type !== "Text");

package/lib/rules/id-naming-convention.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const {
   isCamelCase,
@@ -27,7 +34,7 @@ const CONVENTION_CHECKERS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/indent.js

@@ -1,8 +1,12 @@
 /**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").AnyNode } AnyNode
+ * @typedef { import("../types").LineNode } LineNode
+ * @typedef { import("../types").BaseNode } BaseNode
+ * @typedef { import("../types").TagNode } TagNode
  * @typedef {Object} IndentType
  * @property {"tab"} TAB
  * @property {"space"} SPACE
- *
  * @typedef {Object} MessageId
  * @property {"wrongIndent"} WRONG_INDENT
  */
@@ -24,7 +28,7 @@ const INDENT_TYPES = {
 const IGNORING_NODES = ["pre", "xmp"];
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/lowercase.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ */
+
 const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 
@@ -6,7 +13,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-abstract-roles.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -21,7 +28,7 @@ const ABSTRACT_ROLE_SET = new Set([
 ]);
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-accesskey-attrs.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -6,7 +13,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-aria-hidden-body.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -6,7 +10,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-duplicate-attrs.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -5,7 +12,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-duplicate-id.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -6,7 +13,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-extra-spacing-attrs.js

@@ -1,3 +1,18 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").AttributeNode } AttributeNode
+ * @typedef { import("../types").OpenTagEndNode } OpenTagEndNode
+ * @typedef { import("../types").OpenScriptTagEndNode } OpenScriptTagEndNode
+ * @typedef { import("../types").OpenStyleTagEndNode } OpenStyleTagEndNode
+ * @typedef { import("../types").OpenScriptTagStartNode } OpenScriptTagStartNode
+ * @typedef { import("../types").OpenTagStartNode } OpenTagStartNode
+ * @typedef { import("../types").OpenStyleTagStartNode } OpenStyleTagStartNode
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ * @typedef { import("../types").AnyNode } AnyNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { getLocBetween } = require("./utils/node");
 
@@ -11,7 +26,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-inline-styles.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -6,7 +10,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-multiple-empty-lines.js

@@ -1,3 +1,8 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").ProgramNode } ProgramNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -5,7 +10,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-multiple-h1.js

@@ -1,3 +1,8 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -5,7 +10,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-non-scalable-viewport.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -6,7 +10,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-obsolete-tags.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY, OBSOLETE_TAGS } = require("../constants");
 
 const OBSOLETE_TAGS_SET = new Set(OBSOLETE_TAGS);
@@ -7,7 +11,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-positive-tabindex.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -6,7 +13,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-restricted-attr-values.js

@@ -1,4 +1,9 @@
 /**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").AttributeNode } AttributeNode
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
  * @typedef {{attrPatterns: string[], attrValuePatterns: string[], message?: string}[]} Options
  */
 
@@ -9,7 +14,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-restricted-attrs.js

@@ -1,4 +1,9 @@
 /**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").AttributeNode } AttributeNode
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
  * @typedef {{tagPatterns: string[], attrPatterns: string[], message?: string}[]} Options
  */
 
@@ -10,7 +15,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-script-style-type.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -6,7 +13,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-skip-heading-levels.js

@@ -1,3 +1,8 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -5,7 +10,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-target-blank.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -6,7 +10,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/no-trailing-spaces.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -5,7 +9,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/quotes.js

@@ -1,3 +1,12 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").Range } Range
+ * @typedef { import("../types").AttributeNode } AttributeNode
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -13,7 +22,7 @@ const QUOTES_STYLES = {
 const QUOTES_CODES = [`"`, `'`];
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/require-attrs.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").ScriptTagNode } ScriptTagNode
+ * @typedef { import("../types").StyleTagNode } StyleTagNode
+ */
+
 const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 
@@ -7,7 +14,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -9,7 +13,7 @@ const MESSAGE_IDS = {
 const VALID_BUTTON_TYPES_SET = new Set(["submit", "button", "reset"]);
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

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

@@ -1,3 +1,8 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ */
+
 const { RULE_CATEGORY, VOID_ELEMENTS } = require("../constants");
 
 const VOID_ELEMENTS_SET = new Set(VOID_ELEMENTS);
@@ -9,7 +14,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/require-doctype.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -5,7 +9,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -7,7 +11,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

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

@@ -1,3 +1,8 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -5,7 +10,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

package/lib/rules/require-lang.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 
@@ -7,7 +11,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ */
+
 const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 
@@ -8,7 +12,7 @@ const MESSAGE_IDS = {
 const VALID_CONTAINERS = ["ul", "ol", "menu"];
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {

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

@@ -1,3 +1,8 @@
+/**
+ * @typedef { import("../types").RuleModule } RuleModule
+ * @typedef { import("../types").TagNode } TagNode
+ */
+
 const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 const { find } = require("./utils/array");
@@ -9,7 +14,7 @@ const MESSAGE_IDS = {
 };
 
 /**
- * @param {ChildType<TagNode>} node
+ * @param { import("../types").ChildType<TagNode>} node
  * @returns {node is TagNode}
  */
 function isMetaCharset(node) {
@@ -21,7 +26,7 @@ function isMetaCharset(node) {
 }
 
 /**
- * @type {Rule}
+ * @type {RuleModule}
  */
 module.exports = {
   meta: {