@html-eslint/eslint-plugin 0.40.3 → 0.41.0-alpha.0

package/lib/configs/recommended.js

@@ -1,4 +1,5 @@
-module.exports = {
+/** @satisfies {import('eslint').Linter.FlatConfig} */
+const recommended = {
   rules: {
     "@html-eslint/require-lang": "error",
     "@html-eslint/require-img-alt": "error",
@@ -23,3 +24,5 @@ module.exports = {
     "@html-eslint/use-baseline": "error",
   },
 };
+
+module.exports = recommended;

package/lib/exports.ts

@@ -1,2 +1,2 @@
 import plugin = require("./index");
-export default plugin;
+export = plugin;

package/lib/index.js

@@ -3,25 +3,35 @@ const recommended = require("./configs/recommended");
 const parser = require("@html-eslint/parser");
 const { HTMLLanguage } = require("./languages/html-language");
 const { name, version } = require("../package.json");
+
 /**
- * @typedef {import("./rules")} AllRules
- * @typedef {import("./configs/recommended")} RecommendedConfig
- * @typedef {{name: string, version: string}} PluginMeta
- * @typedef {{recommended: RecommendedConfig, "flat/recommended": import("eslint").Linter.FlatConfig }} HtmlESLintConfigs
- * @typedef {{html: HTMLLanguage}} Languages
+ * @import { ESLint } from "eslint";
  */
 
 /**
- * @type {{meta: PluginMeta, rules: AllRules, configs: HtmlESLintConfigs, languages: Languages}}
+ * @satisfies {ESLint.Plugin}
  */
 const plugin = {
   meta: {
     name,
     version,
   },
-  // @ts-ignore
   configs: {
     recommended,
+
+    "flat/recommended": {
+      plugins: {
+        /** @type {ESLint.Plugin} */
+        get "@html-eslint"() {
+          return plugin;
+        },
+      },
+
+      languageOptions: {
+        parser,
+      },
+      rules: recommended.rules,
+    },
   },
   languages: {
     html: new HTMLLanguage(),
@@ -29,17 +39,4 @@ const plugin = {
   rules,
 };
 
-Object.assign(plugin.configs, {
-  "flat/recommended": {
-    plugins: {
-      "@html-eslint": plugin,
-    },
-
-    languageOptions: {
-      parser,
-    },
-    rules: recommended.rules,
-  },
-});
-
 module.exports = plugin;

package/lib/languages/html-language.js

@@ -2,8 +2,13 @@ const { visitorKeys, parseForESLint } = require("@html-eslint/parser");
 const { HTMLSourceCode } = require("./html-source-code");
 
 /**
- * @typedef {import('@eslint/core').File} File
- * @typedef {import('@html-eslint/parser').ParserOptions} LanguageOptions
+ * @import { Language, ParseResult, File, FileError, OkParseResult } from "@eslint/core";
+ * @import { ParserOptions } from "@html-eslint/parser";
+ * @import { AST } from "eslint";
+ */
+
+/**
+ * @implements {Language<{ LangOptions: ParserOptions; Code: HTMLSourceCode; RootNode: AST.Program; Node: {}}>}
  */
 class HTMLLanguage {
   constructor() {
@@ -31,14 +36,14 @@ class HTMLLanguage {
     this.nodeTypeKey = "type";
 
     /**
-     * The visitor keys for the CSSTree AST.
+     * The visitor keys for the es-html-parser AST.
      * @type {Record<string, string[]>}
      */
     this.visitorKeys = visitorKeys;
   }
 
   /**
-   * @param {LanguageOptions} languageOptions
+   * @param {ParserOptions} languageOptions
    */
   validateLanguageOptions(languageOptions) {
     if (!languageOptions) {
@@ -64,8 +69,8 @@ class HTMLLanguage {
   /**
    * @param {File} file
    * @param {Object} [context]
-   * @param {LanguageOptions} context.languageOptions
-   * @returns {{ok: true; ast: any; comments: any[]} | {ok: false, errors: unknown[]}}
+   * @param {ParserOptions} context.languageOptions
+   * @returns {ParseResult<AST.Program>}
    */
   parse(file, context) {
     const code = /**  @type {string} */ (file.body);
@@ -80,14 +85,14 @@ class HTMLLanguage {
     } catch (e) {
       return {
         ok: false,
-        errors: [e],
+        errors: [/** @type {FileError} */ (e)],
       };
     }
   }
 
   /**
    * @param {File} file
-   * @param {any} parseResult
+   * @param {OkParseResult<AST.Program>} parseResult
    */
   createSourceCode(file, parseResult) {
     return new HTMLSourceCode({

package/lib/rules/attrs-newline.js

@@ -14,6 +14,7 @@
 
 const { RULE_CATEGORY } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 /**
  * @type {MessageId}
@@ -34,6 +35,7 @@ module.exports = {
       description: "Enforce newline between attributes",
       category: RULE_CATEGORY.STYLE,
       recommended: true,
+      url: getRuleUrl("attrs-newline"),
     },
 
     fixable: true,

package/lib/rules/element-newline.js

@@ -29,6 +29,8 @@ const {
   isStyle,
 } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
+
 const MESSAGE_IDS = {
   EXPECT_NEW_LINE_AFTER: "expectAfter",
 };
@@ -84,6 +86,7 @@ module.exports = {
       description: "Enforce newline between elements.",
       category: RULE_CATEGORY.STYLE,
       recommended: true,
+      url: getRuleUrl("element-newline"),
     },
 
     fixable: true,

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

@@ -20,6 +20,7 @@ const {
 } = require("./utils/naming");
 const { findAttr, isAttributesEmpty, hasTemplate } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   WRONG: "wrong",
@@ -51,6 +52,7 @@ module.exports = {
       description: "Enforce consistent naming id attributes",
       category: RULE_CATEGORY.STYLE,
       recommended: false,
+      url: getRuleUrl("id-naming-convention"),
     },
 
     fixable: null,

package/lib/rules/indent/indent.js

@@ -35,7 +35,7 @@
  */
 
 const { parse } = require("@html-eslint/template-parser");
-const { NodeTypes } = require("es-html-parser");
+const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../../constants");
 const {
   splitToLineNodes,
@@ -158,7 +158,7 @@ module.exports = {
         return getTagIncreasingLevel(node);
       }
       const type = node.type;
-      if (type === NodeTypes.Attribute) {
+      if (type === NODE_TYPES.Attribute) {
         const optionIndent = indentLevelOptions[type];
         if (typeof optionIndent === "number") {
           return optionIndent;
@@ -329,7 +329,7 @@ module.exports = {
           indentLevel.indent(node);
           if (hasTemplate(node)) {
             node.parts.forEach((part) => {
-              if (part.type !== NodeTypes.Part) {
+              if (part.type !== NODE_TYPES.Part) {
                 if (part.open) {
                   checkIndent(part.open);
                 }
@@ -362,7 +362,7 @@ module.exports = {
           indentLevel.indent(node);
           if (hasTemplate(node)) {
             node.parts.forEach((part) => {
-              if (part.type !== NodeTypes.Part) {
+              if (part.type !== NODE_TYPES.Part) {
                 if (part.open) {
                   checkIndent(part.open);
                 }

package/lib/rules/index.js

@@ -50,7 +50,7 @@ const noDuplicateClass = require("./no-duplicate-class");
 // import new rule here ↑
 // DO NOT REMOVE THIS COMMENT
 
-module.exports = {
+const rules = {
   "require-lang": requireLang,
   "require-img-alt": requireImgAlt,
   "require-doctype": requireDoctype,
@@ -103,3 +103,8 @@ module.exports = {
   // export new rule here ↑
   // DO NOT REMOVE THIS COMMENT
 };
+
+module.exports =
+  /** @type {Record<string, import('@eslint/core').RuleDefinition>} */ (
+    /** @type {unknown} */ (rules)
+  );

package/lib/rules/lowercase.js

@@ -10,6 +10,7 @@ const { RULE_CATEGORY } = require("../constants");
 const SVG_CAMEL_CASE_ATTRIBUTES = require("../constants/svg-camel-case-attributes");
 const { createVisitors } = require("./utils/visitors");
 const { hasTemplate } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -26,6 +27,7 @@ module.exports = {
       description: "Enforce to use lowercase for tag and attribute names.",
       category: RULE_CATEGORY.STYLE,
       recommended: false,
+      url: getRuleUrl("lowercase"),
     },
 
     fixable: "code",

package/lib/rules/max-element-depth.js

@@ -10,6 +10,7 @@
 
 const { RULE_CATEGORY } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MAX_DEPTH_EXCEEDED: "maxDepthExceeded",
@@ -26,6 +27,7 @@ module.exports = {
       description: "Enforce element maximum depth",
       category: RULE_CATEGORY.STYLE,
       recommended: false,
+      url: getRuleUrl("max-element-depth"),
     },
 
     fixable: null,

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

@@ -8,6 +8,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -39,6 +40,7 @@ module.exports = {
       description: "Disallow to use of abstract roles",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("no-abstract-roles"),
     },
 
     fixable: null,

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

@@ -8,6 +8,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -24,6 +25,7 @@ module.exports = {
       description: "Disallow to use of accesskey attribute",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("no-accesskey-attrs"),
     },
 
     fixable: null,

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

@@ -5,6 +5,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -22,6 +23,7 @@ module.exports = {
         "Disallow to use aria-hidden attributes on the `body` element.",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("no-aria-hidden-body"),
     },
 
     fixable: null,

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

@@ -9,6 +9,7 @@
 
 const { RULE_CATEGORY } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   DUPLICATE_ATTRS: "duplicateAttrs",
@@ -26,6 +27,7 @@ module.exports = {
       description: "Disallow to use duplicate attributes",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: true,
+      url: getRuleUrl("no-duplicate-attrs"),
     },
 
     fixable: null,

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

@@ -10,9 +10,10 @@
  * @property {import("@html-eslint/types").AnyNode['range']} range
  */
 
-const { NodeTypes } = require("es-html-parser");
+const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   DUPLICATE_CLASS: "duplicateClass",
@@ -28,6 +29,7 @@ module.exports = {
       description: "Disallow to use duplicate class",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("no-duplicate-class"),
     },
     fixable: "code",
     schema: [],
@@ -71,7 +73,7 @@ module.exports = {
         if (
           !attributeValue ||
           !attributeValue.value ||
-          attributeValue.parts.some((part) => part.type === NodeTypes.Template)
+          attributeValue.parts.some((part) => part.type === NODE_TYPES.Template)
         ) {
           return;
         }

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

@@ -14,6 +14,7 @@ const {
   shouldCheckTemplateLiteral,
 } = require("./utils/settings");
 const { getSourceCode } = require("./utils/source-code");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   DUPLICATE_ID: "duplicateId",
@@ -30,6 +31,7 @@ module.exports = {
       description: "Disallow to use duplicate id",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: true,
+      url: getRuleUrl("no-duplicate-id"),
     },
 
     fixable: null,

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

@@ -23,6 +23,7 @@ const { RULE_CATEGORY } = require("../constants");
 const { getLocBetween } = require("./utils/node");
 const { getSourceCode } = require("./utils/source-code");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   EXTRA_BETWEEN: "unexpectedBetween",
@@ -49,6 +50,7 @@ module.exports = {
       description: "Disallow an extra spacing around attributes",
       category: RULE_CATEGORY.STYLE,
       recommended: true,
+      url: getRuleUrl("no-extra-spacing-attrs"),
     },
 
     fixable: true,

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

@@ -15,6 +15,7 @@ const { RULE_CATEGORY } = require("../constants");
 const { isTag, isOverlapWithTemplates } = require("./utils/node");
 const { getSourceCode } = require("./utils/source-code");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -31,6 +32,7 @@ module.exports = {
       description: "Disallow unnecessary consecutive spaces",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("no-extra-spacing-text"),
     },
 
     fixable: true,

package/lib/rules/no-heading-inside-button.js

@@ -5,6 +5,8 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findParent, isTag } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
+
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
@@ -22,6 +24,7 @@ module.exports = {
       description: "Disallows the use of heading elements inside <button>.",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("no-heading-inside-button"),
     },
 
     fixable: null,

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

@@ -5,6 +5,8 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
+
 const MESSAGE_IDS = {
   INLINE_STYLE: "unexpectedInlineStyle",
 };
@@ -20,6 +22,7 @@ module.exports = {
       description: "Disallow using inline style",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("no-inline-styles"),
     },
 
     fixable: null,

package/lib/rules/no-invalid-role.js

@@ -2,10 +2,12 @@
  * @typedef { import("../types").RuleModule<[]> } RuleModule
  */
 
-const { NodeTypes } = require("es-html-parser");
+const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
+
 const MESSAGE_IDS = {
   INVALID: "invalid",
   INVALID_PRESENTATION: "invalidPresentation",
@@ -235,6 +237,7 @@ module.exports = {
       description: "Disallows use of invalid role.",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("no-invalid-role"),
     },
 
     fixable: null,
@@ -259,7 +262,7 @@ module.exports = {
          */
         if (
           role.value &&
-          role.value.parts.some((part) => part.type === NodeTypes.Template)
+          role.value.parts.some((part) => part.type === NODE_TYPES.Template)
         ) {
           return;
         }

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

@@ -1,5 +1,5 @@
 /**
- * @typedef { import("es-html-parser").AnyToken } AnyToken
+ * @typedef { import("@html-eslint/types").AnyToken } AnyToken
  * @typedef { import("@html-eslint/types").Document } Document
  * @typedef { import("@html-eslint/types").CommentContent } CommentContent
  * @typedef { import("@html-eslint/types").Text } Text
@@ -21,6 +21,7 @@ const {
   isRangesOverlap,
   getTemplateTokens,
 } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -37,6 +38,7 @@ module.exports = {
       description: "Disallow multiple empty lines",
       category: RULE_CATEGORY.STYLE,
       recommended: false,
+      url: getRuleUrl("no-multiple-empty-lines"),
     },
 
     fixable: "whitespace",

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

@@ -4,6 +4,7 @@
  */
 
 const { RULE_CATEGORY } = require("../constants");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MULTIPLE_H1: "unexpectedMultiH1",
@@ -20,6 +21,7 @@ module.exports = {
       description: "Disallow multiple `<h1></h1>`.",
       category: RULE_CATEGORY.SEO,
       recommended: true,
+      url: getRuleUrl("no-multiple-h1"),
     },
 
     fixable: null,

package/lib/rules/no-nested-interactive.js

@@ -6,6 +6,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -65,6 +66,7 @@ module.exports = {
       description: "Disallows nested interactive elements",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("no-nested-interactive"),
     },
 
     fixable: null,

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

@@ -4,6 +4,7 @@
 
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -21,6 +22,7 @@ module.exports = {
         'Disallow use of `user-scalable=no` in `<meta name="viewport">`.',
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("no-non-scalable-viewport"),
     },
 
     fixable: null,

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

@@ -4,6 +4,7 @@
 
 const { RULE_CATEGORY, OBSOLETE_TAGS } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const OBSOLETE_TAGS_SET = new Set(OBSOLETE_TAGS);
 
@@ -22,6 +23,7 @@ module.exports = {
       description: "Disallow to use obsolete elements in HTML5",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: true,
+      url: getRuleUrl("no-obsolete-tags"),
     },
 
     fixable: null,

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

@@ -8,6 +8,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -24,6 +25,7 @@ module.exports = {
       description: "Disallow use of positive `tabindex`.",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("no-positive-tabindex"),
     },
 
     fixable: null,

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

@@ -9,6 +9,7 @@
 
 const { RULE_CATEGORY } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   RESTRICTED: "restricted",
@@ -25,6 +26,7 @@ module.exports = {
       description: "Disallow specified attributes",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("no-restricted-attr-values"),
     },
 
     fixable: null,

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

@@ -11,6 +11,7 @@
 const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   RESTRICTED: "restricted",
@@ -27,6 +28,7 @@ module.exports = {
       description: "Disallow specified attributes",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("no-restricted-attrs"),
     },
 
     fixable: null,

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

@@ -8,6 +8,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNNECESSARY: "unnecessary",
@@ -25,6 +26,7 @@ module.exports = {
         "Enforce to omit type attributes for style sheets and scripts",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("no-script-style-type"),
     },
 
     fixable: "code",

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

@@ -4,6 +4,7 @@
  */
 
 const { RULE_CATEGORY } = require("../constants");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -20,6 +21,7 @@ module.exports = {
       description: "Disallow skipping heading levels",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("no-skip-heading-levels"),
     },
 
     fixable: null,