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

package/lib/rules/no-target-blank.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 = {
   MISSING: "missing",
@@ -21,6 +22,7 @@ module.exports = {
       description: "Disallow usage of unsafe `target='_blank'`",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("no-target-blank"),
     },
 
     fixable: null,

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

@@ -16,6 +16,7 @@ const {
   shouldCheckTemplateLiteral,
 } = require("./utils/settings");
 const { getSourceCode } = require("./utils/source-code");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   TRAILING_SPACE: "trailingSpace",
@@ -31,6 +32,7 @@ module.exports = {
       description: "Disallow trailing whitespace at the end of lines",
       recommended: false,
       category: RULE_CATEGORY.STYLE,
+      url: getRuleUrl("no-trailing-spaces"),
     },
     fixable: true,
     schema: [],

package/lib/rules/prefer-https.js

@@ -9,6 +9,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr, isScript } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -74,6 +75,7 @@ module.exports = {
       description: "Prefer to use HTTPS for embedded resources",
       recommended: false,
       category: RULE_CATEGORY.BEST_PRACTICE,
+      url: getRuleUrl("prefer-https"),
     },
     fixable: false,
     schema: [],

package/lib/rules/quotes.js

@@ -9,10 +9,11 @@
  * @typedef { import("../types").RuleModule<[Option]> } RuleModule
  */
 
-const { NodeTypes } = require("es-html-parser");
+const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
 const { getSourceCode } = require("./utils/source-code");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -38,6 +39,7 @@ module.exports = {
         "Enforce consistent quoting attributes with double(\") or single(')",
       category: RULE_CATEGORY.STYLE,
       recommended: true,
+      url: getRuleUrl("quotes"),
     },
     fixable: true,
     schema: [
@@ -92,7 +94,7 @@ module.exports = {
        * Allow template expression.
        * ex: html`<div foo=${foo}></div>`
        */
-      if (attr.value.parts.some((part) => part.type === NodeTypes.Template)) {
+      if (attr.value.parts.some((part) => part.type === NODE_TYPES.Template)) {
         return;
       }
 

package/lib/rules/require-attrs.js

@@ -17,6 +17,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 = {
   MISSING: "missing",
@@ -34,6 +35,7 @@ module.exports = {
       description: "Require specified attributes",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("require-attrs"),
     },
     fixable: "code",
     schema: {

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

@@ -7,6 +7,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING: "missing",
@@ -29,6 +30,7 @@ module.exports = {
       description: "Require use of button element with a valid type attribute.",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("require-button-type"),
     },
 
     fixable: true,

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

@@ -9,6 +9,7 @@
 
 const { RULE_CATEGORY, VOID_ELEMENTS } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const VOID_ELEMENTS_SET = new Set(VOID_ELEMENTS);
 
@@ -29,6 +30,7 @@ module.exports = {
       description: "Require closing tags.",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: true,
+      url: getRuleUrl("require-closing-tags"),
     },
 
     fixable: true,

package/lib/rules/require-doctype.js

@@ -3,6 +3,7 @@
  */
 
 const { RULE_CATEGORY } = require("../constants");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING: "missing",
@@ -19,6 +20,7 @@ module.exports = {
       description: "Require `<!DOCTYPE HTML>` in html,",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: true,
+      url: getRuleUrl("require-doctype"),
     },
 
     fixable: true,

package/lib/rules/require-explicit-size.js

@@ -12,6 +12,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING_HEIGHT: "missingHeight",
@@ -32,6 +33,7 @@ module.exports = {
         "Enforces that some elements (img, iframe) have explicitly defined width and height attributes.",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("require-explicit-size"),
     },
 
     fixable: null,

package/lib/rules/require-form-method.js

@@ -2,10 +2,11 @@
  * @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 = {
   MISSING: "missing",
@@ -26,6 +27,7 @@ module.exports = {
       description: "Require `method` attribute in `<form>`",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("require-form-method"),
     },
 
     fixable: false,
@@ -65,7 +67,7 @@ module.exports = {
 
         if (
           method.value.parts &&
-          method.value.parts.some((part) => part.type !== NodeTypes.Part)
+          method.value.parts.some((part) => part.type !== NODE_TYPES.Part)
         ) {
           return;
         }

package/lib/rules/require-frame-title.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 = {
   MISSING: "missing",
@@ -22,6 +23,7 @@ module.exports = {
       description: "Require `title` in `<frame>`, `<iframe>`",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("require-frame-title"),
     },
 
     fixable: false,

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

@@ -9,6 +9,7 @@
 
 const { RULE_CATEGORY } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING_ALT: "missingAlt",
@@ -25,6 +26,7 @@ module.exports = {
       description: "Require `alt` attribute at `<img>` tag",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: true,
+      url: getRuleUrl("require-img-alt"),
     },
 
     fixable: null,

package/lib/rules/require-input-label.js

@@ -6,6 +6,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
 const { findParent, isTag } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING: "missingLabel",
@@ -27,6 +28,7 @@ module.exports = {
         "Enforces use of label for form elements(`input`, `textarea`, `select`)",
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("require-input-label"),
     },
     fixable: null,
     schema: [],

package/lib/rules/require-lang.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 = {
   MISSING: "missing",
@@ -22,6 +23,7 @@ module.exports = {
       description: "Require `lang` attribute at `<html>` tag",
       category: RULE_CATEGORY.SEO,
       recommended: true,
+      url: getRuleUrl("require-lang"),
     },
 
     fixable: null,

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

@@ -4,6 +4,7 @@
 
 const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   INVALID: "invalid",
@@ -22,6 +23,7 @@ module.exports = {
       description: "Enforce `<li>` to be in  `<ul>`, `<ol>` or `<menu>`.",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: true,
+      url: getRuleUrl("require-li-container"),
     },
 
     fixable: null,

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

@@ -7,6 +7,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { find } = require("./utils/array");
 const { findAttr, isTag } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING: "missing",
@@ -32,6 +33,7 @@ module.exports = {
       description: 'Enforce to use `<meta charset="...">` in `<head>`',
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: false,
+      url: getRuleUrl("require-meta-charset"),
     },
 
     fixable: null,

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

@@ -6,6 +6,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { filter } = require("./utils/array");
 const { findAttr, isTag } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING: "missing",
@@ -31,6 +32,7 @@ module.exports = {
       description: 'Require use of `<meta name="description">` in `<head>`',
       category: RULE_CATEGORY.SEO,
       recommended: false,
+      url: getRuleUrl("require-meta-description"),
     },
 
     fixable: null,

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

@@ -7,6 +7,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { find } = require("./utils/array");
 const { findAttr, isTag } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING: "missing",
@@ -40,6 +41,7 @@ module.exports = {
       description: 'Enforce to use `<meta name="viewport">` in `<head>`',
       category: RULE_CATEGORY.ACCESSIBILITY,
       recommended: false,
+      url: getRuleUrl("require-meta-viewport"),
     },
 
     fixable: null,

package/lib/rules/require-open-graph-protocol.js

@@ -10,6 +10,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { filter } = require("./utils/array");
 const { findAttr, isTag } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING: "missing",
@@ -42,9 +43,11 @@ module.exports = {
     type: "code",
 
     docs: {
-      description: 'Enforce to use `<meta name="viewport">` in `<head>`',
+      description:
+        "Enforce to use specified meta tags for open graph protocol.",
       category: RULE_CATEGORY.SEO,
       recommended: false,
+      url: getRuleUrl("require-open-graph-protocol"),
     },
 
     fixable: null,

package/lib/rules/require-title.js

@@ -8,6 +8,7 @@
 const { RULE_CATEGORY } = require("../constants");
 const { find } = require("./utils/array");
 const { isText, isTag } = require("./utils/node");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   MISSING_TITLE: "missing",
@@ -41,6 +42,7 @@ module.exports = {
       description: "Require `<title><title/>` in the `<head><head/>`",
       category: RULE_CATEGORY.SEO,
       recommended: true,
+      url: getRuleUrl("require-title"),
     },
 
     fixable: null,

package/lib/rules/sort-attrs.js

@@ -12,6 +12,7 @@ const { hasTemplate } = require("./utils/node");
 const { RULE_CATEGORY } = require("../constants");
 const { getSourceCode } = require("./utils/source-code");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   UNSORTED: "unsorted",
@@ -28,6 +29,7 @@ module.exports = {
       description: "Enforce attributes alphabetical sorting",
       category: RULE_CATEGORY.STYLE,
       recommended: false,
+      url: getRuleUrl("sort-attrs"),
     },
     fixable: "code",
     schema: [

package/lib/rules/use-baseline.js

@@ -16,6 +16,7 @@ const {
   BASELINE_LOW,
 } = require("./utils/baseline");
 const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
 
 const MESSAGE_IDS = {
   NOT_BASELINE_ELEMENT: "notBaselineElement",
@@ -33,6 +34,7 @@ module.exports = {
       description: "Enforce the use of baseline features.",
       recommended: true,
       category: RULE_CATEGORY.BEST_PRACTICE,
+      url: getRuleUrl("use-baseline"),
     },
     fixable: null,
     schema: [

package/lib/rules/utils/node.js

@@ -16,11 +16,10 @@
  * @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
+ * @typedef { import("@html-eslint/types").AnyToken } AnyToken
  */
 
 const { NODE_TYPES } = require("@html-eslint/parser");
-const { NodeTypes, TokenTypes } = require("es-html-parser");
 
 /**
  * @param {Tag | ScriptTag | StyleTag} node
@@ -68,7 +67,7 @@ function isRangesOverlap(rangeA, rangeB) {
  */
 function isOverlapWithTemplates(parts, range) {
   return parts
-    .filter((part) => part.type !== NodeTypes.Part)
+    .filter((part) => part.type !== NODE_TYPES.Part)
     .some((part) => isRangesOverlap(part.range, range));
 }
 
@@ -77,7 +76,7 @@ function isOverlapWithTemplates(parts, range) {
  * @returns {boolean}
  */
 function hasTemplate(node) {
-  return node.parts.some((part) => part.type !== NodeTypes.Part);
+  return node.parts.some((part) => part.type !== NODE_TYPES.Part);
 }
 
 /**
@@ -101,7 +100,7 @@ function splitToLineNodes(node) {
   function hasTemplate(range) {
     return parts.some(
       (part) =>
-        part.type !== NodeTypes.Part && isRangesOverlap(part.range, range)
+        part.type !== NODE_TYPES.Part && isRangesOverlap(part.range, range)
     );
   }
 
@@ -248,7 +247,7 @@ function getTemplateTokens(tokens) {
           .map((token) => token["parts"] || [])
       )
       // @ts-ignore
-      .filter((token) => token.type !== TokenTypes.Part)
+      .filter((token) => token.type !== NODE_TYPES.Part)
   );
 }
 

package/lib/rules/utils/rule.js

@@ -0,0 +1,11 @@
+/**
+ *
+ * @param {string} ruleName
+ */
+function getRuleUrl(ruleName) {
+  return "https://html-eslint.org/docs/rules/" + ruleName;
+}
+
+module.exports = {
+  getRuleUrl,
+};

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.40.3",
-  "description": "ESLint plugin for html",
+  "version": "0.41.0-alpha.0",
+  "type": "commonjs",
+  "description": "ESLint plugin for HTML",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
   "license": "MIT",
@@ -23,7 +24,7 @@
     "test:legacy": "TEST_ESLINT_LEGACY_CONFIG=true && jest",
     "ts": "tsc --noEmit",
     "lint": "eslint .",
-    "build": "rimraf types && tsc  --project tsconfig.build.json"
+    "build": "rimraf types && tsc --project tsconfig.build.json"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
@@ -38,20 +39,25 @@
     "accessibility"
   ],
   "dependencies": {
-    "@eslint/plugin-kit": "0.2.8",
-    "@html-eslint/parser": "^0.40.0",
-    "@html-eslint/template-parser": "^0.40.0",
-    "@html-eslint/template-syntax-parser": "^0.40.0"
+    "@eslint/plugin-kit": "^0.3.1",
+    "@html-eslint/parser": "^0.41.0-alpha.0",
+    "@html-eslint/template-parser": "^0.41.0-alpha.0",
+    "@html-eslint/template-syntax-parser": "^0.41.0-alpha.0"
+  },
+  "peerDependencies": {
+    "eslint": "^8.0.0 || ^9.0.0"
   },
   "devDependencies": {
-    "@eslint/core": "0.13.0",
-    "@html-eslint/types": "^0.40.0",
-    "@types/eslint": "^9.6.1",
+    "@eslint/core": "^0.14.0",
+    "@html-eslint/types": "^0.41.0-alpha.0",
     "@types/estree": "^0.0.47",
     "es-html-parser": "0.2.0",
-    "eslint": "^9.21.0",
+    "eslint": "^9.27.0",
     "espree": "^10.3.0",
-    "typescript": "^5.7.2"
+    "typescript": "^5.8.3"
+  },
+  "engines": {
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   },
-  "gitHead": "91e2ce609118eb1d0b2e2078fe465776bc60bc51"
+  "gitHead": "a1d2d99f91d5adc86184ea15151b5c04bd53ea8d"
 }

package/types/configs/recommended.d.ts

@@ -1,21 +1,21 @@
 export let rules: {
-    "@html-eslint/require-lang": string;
-    "@html-eslint/require-img-alt": string;
-    "@html-eslint/require-doctype": string;
-    "@html-eslint/require-title": string;
-    "@html-eslint/no-multiple-h1": string;
-    "@html-eslint/no-extra-spacing-attrs": string;
-    "@html-eslint/attrs-newline": string;
-    "@html-eslint/element-newline": (string | {
+    "@html-eslint/require-lang": "error";
+    "@html-eslint/require-img-alt": "error";
+    "@html-eslint/require-doctype": "error";
+    "@html-eslint/require-title": "error";
+    "@html-eslint/no-multiple-h1": "error";
+    "@html-eslint/no-extra-spacing-attrs": "error";
+    "@html-eslint/attrs-newline": "error";
+    "@html-eslint/element-newline": ["error", {
         inline: string[];
-    })[];
-    "@html-eslint/no-duplicate-id": string;
-    "@html-eslint/indent": string;
-    "@html-eslint/require-li-container": string;
-    "@html-eslint/quotes": string;
-    "@html-eslint/no-obsolete-tags": string;
-    "@html-eslint/require-closing-tags": string;
-    "@html-eslint/no-duplicate-attrs": string;
-    "@html-eslint/use-baseline": string;
+    }];
+    "@html-eslint/no-duplicate-id": "error";
+    "@html-eslint/indent": "error";
+    "@html-eslint/require-li-container": "error";
+    "@html-eslint/quotes": "error";
+    "@html-eslint/no-obsolete-tags": "error";
+    "@html-eslint/require-closing-tags": "error";
+    "@html-eslint/no-duplicate-attrs": "error";
+    "@html-eslint/use-baseline": "error";
 };
 //# sourceMappingURL=recommended.d.ts.map

package/types/exports.d.ts

@@ -1,3 +1,3 @@
 import plugin = require("./index");
-export default plugin;
+export = plugin;
 //# sourceMappingURL=exports.d.ts.map

package/types/exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../lib/exports.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,GAAG,QAAQ,SAAS,CAAC,CAAC;AACnC,eAAe,MAAM,CAAC"}
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../lib/exports.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,GAAG,QAAQ,SAAS,CAAC,CAAC;AACnC,SAAS,MAAM,CAAC"}