@html-eslint/eslint-plugin 0.50.0 → 0.52.0

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

@@ -1,6 +1,4 @@
-/**
- * @import {RuleModule} from "../types";
- */
+/** @import {RuleModule} from "../types" */
 
 const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
@@ -16,9 +14,7 @@ const MESSAGE_IDS = {
 
 const ALLOWED_METHODS = new Set(["GET", "POST", "DIALOG"]);
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,6 +1,4 @@
-/**
- * @import {RuleModule} from "../types";
- */
+/** @import {RuleModule} from "../types" */
 
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
@@ -12,9 +10,7 @@ const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,7 +1,6 @@
 /**
- * @import {Tag} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
- *
+ * @import {Tag} from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  * @typedef {Object} Option
  * @property {string[]} [substitute]
  */
@@ -15,9 +14,7 @@ const MESSAGE_IDS = {
   INSERT_ALT: "insertAlt",
 };
 
-/**
- * @type {RuleModule<[Option]>}
- */
+/** @type {RuleModule<[Option]>} */
 module.exports = {
   meta: {
     type: "suggestion",

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

@@ -1,6 +1,6 @@
 /**
- * @import {RuleModule} from "../types";
- * @import {Tag} from "@html-eslint/types";
+ * @import {Tag} from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -16,9 +16,7 @@ const INPUT_TAGS = new Set(["input", "textarea", "select"]);
 
 const LABEL_ATTRIBUTES = new Set(["id", "aria-labelledby", "aria-label"]);
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

package/lib/rules/require-lang.js

@@ -1,6 +1,4 @@
-/**
- * @import {RuleModule} from "../types";
- */
+/** @import {RuleModule} from "../types" */
 
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
@@ -12,9 +10,7 @@ const MESSAGE_IDS = {
   EMPTY: "empty",
 };
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,6 +1,4 @@
-/**
- * @import {RuleModule} from "../types";
- */
+/** @import {RuleModule} from "../types" */
 
 const { NODE_TYPES } = require("@html-eslint/parser");
 const { RULE_CATEGORY } = require("../constants");
@@ -12,9 +10,7 @@ const MESSAGE_IDS = {
 
 const VALID_CONTAINERS = ["ul", "ol", "menu"];
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,6 +1,9 @@
 /**
- * @import {RuleModule} from "../types";
- * @import {Tag, AnyNode} from "@html-eslint/types";
+ * @import {
+ *   AnyNode,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -21,9 +24,7 @@ function isMetaCharset(node) {
   return isTag(node) && node.name === "meta" && !!findAttr(node, "charset");
 }
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,6 +1,9 @@
 /**
- * @import {Tag, AnyNode} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {
+ *   AnyNode,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 const { RULE_CATEGORY } = require("../constants");
 const { filter } = require("./utils/array");
@@ -20,9 +23,7 @@ function isMetaTagNode(node) {
   return isTag(node) && node.name === "meta";
 }
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,6 +1,9 @@
 /**
- * @import {Tag, AnyNode} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {
+ *   AnyNode,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -29,9 +32,7 @@ function isMetaViewport(node) {
   return false;
 }
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,6 +1,9 @@
 /**
- * @import {Tag, AnyNode} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {
+ *   AnyNode,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  * @typedef {string[]} Option
  */
 
@@ -32,9 +35,7 @@ function normalize(properties) {
   });
 }
 
-/**
- * @type {RuleModule<[Option]>}
- */
+/** @type {RuleModule<[Option]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -65,9 +66,7 @@ module.exports = {
   },
 
   create(context) {
-    /**
-     * @type {string[]}
-     */
+    /** @type {string[]} */
     const requiredProperties = normalize(
       (context.options && context.options[0]) || DEFAULT_REQUIRED_PROPERTIES
     );

package/lib/rules/require-title.js

@@ -1,6 +1,10 @@
 /**
- * @import {Tag, Text, AnyNode} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {
+ *   AnyNode,
+ *   Tag,
+ *   Text
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -29,9 +33,7 @@ function isNonEmptyText(node) {
   return isText(node) && node.value.trim().length > 0;
 }
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

package/lib/rules/sort-attrs.js

@@ -1,9 +1,11 @@
 /**
- * @import {Attribute} from "@html-eslint/types";
- * @import {RuleFixer, RuleModule} from "../types";
- *
+ * @import {Attribute} from "@html-eslint/types"
+ * @import {
+ *   RuleFixer,
+ *   RuleModule
+ * } from "../types"
  * @typedef {Object} Option
- * @property {Array<string | {pattern: string}>} [Option.priority]
+ * @property {(string | { pattern: string })[]} [Option.priority]
  */
 
 const { hasTemplate } = require("./utils/node");
@@ -16,9 +18,7 @@ const MESSAGE_IDS = {
   UNSORTED: "unsorted",
 };
 
-/**
- * @type {RuleModule<[Option]>}
- */
+/** @type {RuleModule<[Option]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -69,9 +69,7 @@ module.exports = {
     const option = context.options[0] || {
       priority: ["id", "type", "class", "style"],
     };
-    /**
-     * @type {Array<string | {pattern: string, regex: RegExp}>}
-     */
+    /** @type {(string | { pattern: string; regex: RegExp })[]} */
     const priority = (option.priority || []).map((item) => {
       if (item && typeof item === "object" && "pattern" in item) {
         return {
@@ -84,7 +82,7 @@ module.exports = {
 
     /**
      * @param {string} attrName
-     * @param {string | {pattern: string, regex: RegExp}} priorityItem
+     * @param {string | { pattern: string; regex: RegExp }} priorityItem
      * @returns {boolean}
      */
     function matchesPriority(attrName, priorityItem) {
@@ -117,7 +115,7 @@ module.exports = {
     /**
      * @param {Attribute} attrA
      * @param {Attribute} attrB
-     * @return {number}
+     * @returns {number}
      */
     function compare(attrA, attrB) {
       const keyA = attrA.key.value;
@@ -185,12 +183,10 @@ module.exports = {
 
     /**
      * @param {Attribute[]} attributes
-     * @return {Attribute[][]}
+     * @returns {Attribute[][]}
      */
     function groupAttributes(attributes) {
-      /**
-       * @type {Attribute[][]}
-       */
+      /** @type {Attribute[][]} */
       const attributesList = [];
       let index = 0;
 
@@ -207,9 +203,7 @@ module.exports = {
       return attributesList;
     }
 
-    /**
-     * @param {Attribute[]} unsorted
-     */
+    /** @param {Attribute[]} unsorted */
     function checkSorting(unsorted) {
       if (unsorted.length <= 1) {
         return;

package/lib/rules/use-baseline.js

@@ -1,6 +1,11 @@
 /**
- * @import {RuleModule} from "../types";
- * @import {Attribute, Tag, ScriptTag, StyleTag} from "@html-eslint/types";
+ * @import {
+ *   Attribute,
+ *   ScriptTag,
+ *   StyleTag,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  * @typedef {Object} Option
  * @property {"widely" | "newly" | number} Option.available
  */
@@ -21,9 +26,7 @@ const MESSAGE_IDS = {
   NOT_BASELINE_GLOBAL_ATTRIBUTE: "notBaselineGlobalAttribute",
 };
 
-/**
- * @type {RuleModule<[Option]>}
- */
+/** @type {RuleModule<[Option]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -178,7 +181,6 @@ module.exports = {
     }
 
     /**
-     *
      * @param {string} element
      * @param {string} key
      * @param {string} value

package/lib/rules/utils/baseline.js

@@ -1,6 +1,4 @@
-/**
- * This file is auto-generated. (yarn run baseline)
- */
+/** This file is auto-generated. (yarn run baseline) */
 const BASELINE_HIGH = 10;
 const BASELINE_LOW = 5;
 const BASELINE_FALSE = 0;
@@ -70,9 +68,9 @@ const elements = new Map([
   ["body", "10:2015"],
   ["br", "10:2015"],
   ["button", "10:2015"],
-  ["button.command", "0:"],
-  ["button.command.request-close", "0:"],
-  ["button.commandfor", "0:"],
+  ["button.command", "5:2025"],
+  ["button.command.request-close", "5:2025"],
+  ["button.commandfor", "5:2025"],
   ["button.disabled", "10:2015"],
   ["button.form", "10:2017"],
   ["button.formaction", "10:2015"],

package/lib/rules/utils/naming.js

@@ -7,8 +7,10 @@ const CAMEL_CASE_REGEX = /^[a-z][a-zA-Z0-9]+$/;
 module.exports = {
   /**
    * Checks a given name follows `kebab-case` or not.
-   * @param {string} name name to check
-   * @returns {boolean} `true` if a name follows `kebab-case`, otherwise `false`.
+   *
+   * @param {string} name Name to check
+   * @returns {boolean} `true` if a name follows `kebab-case`, otherwise
+   *   `false`.
    */
   isKebabCase(name) {
     return KEBAB_CASE_REGEX.test(name);
@@ -16,8 +18,10 @@ module.exports = {
 
   /**
    * Checks a given name follows `snake_case` or not.
-   * @param {string} name name to check
-   * @returns {boolean} `true` if a name follows `snake_case`, otherwise `false`.
+   *
+   * @param {string} name Name to check
+   * @returns {boolean} `true` if a name follows `snake_case`, otherwise
+   *   `false`.
    */
   isSnakeCase(name) {
     return SNAKE_CASE_REGEX.test(name);
@@ -25,8 +29,10 @@ module.exports = {
 
   /**
    * Checks a given name follows `PascalCase` or not.
-   * @param {string} name name to check
-   * @returns {boolean} `true` if a name follows `PascalCase`, otherwise `false`.
+   *
+   * @param {string} name Name to check
+   * @returns {boolean} `true` if a name follows `PascalCase`, otherwise
+   *   `false`.
    */
   isPascalCase(name) {
     return PASCAL_CASE_REGEX.test(name);
@@ -34,7 +40,8 @@ module.exports = {
 
   /**
    * Checks a given name follows `camelCase` or not.
-   * @param {string} name name to check
+   *
+   * @param {string} name Name to check
    * @returns {boolean} `true` if a name follows `camelCase`, otherwise `false`.
    */
   isCamelCase(name) {

package/lib/rules/utils/node.js

@@ -1,7 +1,24 @@
 /**
- * @import {Attribute, Tag, ScriptTag, StyleTag, AnyNode, Text, CommentContent, Comment, AttributeValue, AttributeKey, AnyToken} from "@html-eslint/types";
- * @import {Line, BaseNode} from "../../types";
- * @import {AST} from "eslint";
+ * @import {
+ *   AnyNode,
+ *   AnyToken,
+ *   Attribute,
+ *   AttributeKey,
+ *   AttributeValue,
+ *   CloseTemplate,
+ *   Comment,
+ *   CommentContent,
+ *   OpenTemplate,
+ *   ScriptTag,
+ *   StyleTag,
+ *   Tag,
+ *   Text
+ * } from "@html-eslint/types"
+ * @import {AST} from "eslint"
+ * @import {
+ *   BaseNode,
+ *   Line
+ * } from "../../types"
  */
 
 const { NODE_TYPES } = require("@html-eslint/parser");
@@ -30,6 +47,7 @@ function hasAttr(node, attrName) {
 
 /**
  * Checks whether a node's attributes is empty or not.
+ *
  * @param {Tag | ScriptTag | StyleTag} node
  * @returns {boolean}
  */
@@ -39,15 +57,16 @@ function isAttributesEmpty(node) {
 
 /**
  * Checks whether a node's all tokens are on the same line or not.
+ *
  * @param {AnyNode} node A node to check
- * @returns {boolean} `true` if a node's tokens are on the same line, otherwise `false`.
+ * @returns {boolean} `true` if a node's tokens are on the same line, otherwise
+ *   `false`.
  */
 function isNodeTokensOnSameLine(node) {
   return node.loc.start.line === node.loc.end.line;
 }
 
 /**
- *
  * @param {AST.Range} rangeA
  * @param {AST.Range} rangeB
  * @returns {boolean}
@@ -57,7 +76,7 @@ function isRangesOverlap(rangeA, rangeB) {
 }
 
 /**
- * @param {(Text | CommentContent)['parts']} parts
+ * @param {(Text | CommentContent)["parts"]} parts
  * @param {AST.Range} range
  * @returns {boolean}
  */
@@ -76,7 +95,6 @@ function hasTemplate(node) {
 }
 
 /**
- *
  * @param {Text | CommentContent} node
  * @returns {Line[]}
  */
@@ -84,27 +102,45 @@ function splitToLineNodes(node) {
   let start = node.range[0];
   let line = node.loc.start.line;
   const startCol = node.loc.start.column;
-  /**
-   * @type {Line[]}
-   */
+  /** @type {Line[]} */
   const lineNodes = [];
   const parts = node.parts || [];
+
   /**
-   *
    * @param {AST.Range} range
+   * @returns {{
+   *   isOverlapTemplate: boolean;
+   *   hasOpenTemplate: boolean;
+   *   hasCloseTemplate: boolean;
+   * }}
    */
-  function hasTemplate(range) {
-    return parts.some(
-      (part) =>
-        part.type !== NODE_TYPES.Part && isRangesOverlap(part.range, range)
-    );
+  function getTemplateInfo(range) {
+    let isOverlapTemplate = false;
+    let hasOpenTemplate = false;
+    let hasCloseTemplate = false;
+    for (const part of parts) {
+      if (part.type === NODE_TYPES.Template) {
+        if (isRangesOverlap(part.range, range)) {
+          isOverlapTemplate = true;
+        }
+        if (part.open && isRangesOverlap(part.open.range, range)) {
+          hasOpenTemplate = true;
+        }
+        if (part.close && isRangesOverlap(part.close.range, range)) {
+          hasCloseTemplate = true;
+        }
+      }
+    }
+    return {
+      isOverlapTemplate,
+      hasCloseTemplate,
+      hasOpenTemplate,
+    };
   }
 
   node.value.split("\n").forEach((value, index) => {
     const columnStart = index === 0 ? startCol : 0;
-    /**
-     * @type {AST.Range}
-     */
+    /** @type {AST.Range} */
     const range = [start, start + value.length];
     const loc = {
       start: {
@@ -116,15 +152,13 @@ function splitToLineNodes(node) {
         column: columnStart + value.length,
       },
     };
-    /**
-     * @type {Line}
-     */
+    /** @type {Line} */
     const lineNode = {
       type: "Line",
       value,
       range,
       loc,
-      hasTemplate: hasTemplate(range),
+      ...getTemplateInfo(range),
     };
 
     start += value.length + 1;
@@ -138,9 +172,10 @@ function splitToLineNodes(node) {
 
 /**
  * Get location between two nodes.
- * @param {{loc: AST.SourceLocation}} before A node placed in before
- * @param {{loc: AST.SourceLocation}} after A node placed in after
- * @returns {AST.SourceLocation} location between two nodes.
+ *
+ * @param {{ loc: AST.SourceLocation }} before A node placed in before
+ * @param {{ loc: AST.SourceLocation }} after A node placed in after
+ * @returns {AST.SourceLocation} Location between two nodes.
  */
 function getLocBetween(before, after) {
   return {
@@ -230,9 +265,8 @@ function findParent(node, predicate) {
 }
 
 /**
- *
  * @param {AnyToken[]} tokens
- * @returns {((CommentContent | Text)['parts'][number])[]}
+ * @returns {(CommentContent | Text)["parts"][number][]}
  */
 function getTemplateTokens(tokens) {
   return (
@@ -258,7 +292,7 @@ function getNameOf(node) {
   if (isStyle(node)) {
     return "style";
   }
-  return node.name;
+  return node.name.toLowerCase();
 }
 
 module.exports = {

package/lib/rules/utils/rule.js

@@ -1,7 +1,4 @@
-/**
- *
- * @param {string} ruleName
- */
+/** @param {string} ruleName */
 function getRuleUrl(ruleName) {
   return "https://html-eslint.org/docs/rules/" + ruleName;
 }

package/lib/rules/utils/settings.js

@@ -1,6 +1,13 @@
 /**
- * @import {MaybeHTMLSettings, HTMLSettings, Context} from "../../types";
- * @import {TaggedTemplateExpression, TemplateLiteral} from "@html-eslint/types";
+ * @import {
+ *   TaggedTemplateExpression,
+ *   TemplateLiteral
+ * } from "@html-eslint/types"
+ * @import {
+ *   Context,
+ *   HTMLSettings,
+ *   MaybeHTMLSettings
+ * } from "../../types"
  */
 
 const { getSourceCode } = require("../utils/source-code");
@@ -54,7 +61,6 @@ function shouldCheckTaggedTemplateExpression(node, context) {
 }
 
 /**
- *
  * @param {TemplateLiteral} node
  * @param {Context<any[]>} context
  * @returns {boolean}

package/lib/rules/utils/source-code.js

@@ -1,10 +1,6 @@
-/**
- * @import {Context} from "../../types";
- */
+/** @import {Context} from "../../types" */
 
-/**
- * @param {Context<any[]>} context
- */
+/** @param {Context<any[]>} context */
 function getSourceCode(context) {
   return context.sourceCode || context.getSourceCode();
 }