@herb-tools/linter 0.4.3 → 0.6.0

package/src/rules/html-no-duplicate-attributes.ts

@@ -1,46 +1,44 @@
-import { BaseRuleVisitor, forEachAttribute } from "./rule-utils.js"
-
 import { ParserRule } from "../types.js"
+import { AttributeVisitorMixin, StaticAttributeStaticValueParams, StaticAttributeDynamicValueParams } from "./rule-utils.js"
+
 import type { LintOffense, LintContext } from "../types.js"
-import type { HTMLOpenTagNode, HTMLSelfCloseTagNode, HTMLAttributeNameNode, Node } from "@herb-tools/core"
+import type { HTMLOpenTagNode, HTMLAttributeNode, ParseResult } from "@herb-tools/core"
+
+class NoDuplicateAttributesVisitor extends AttributeVisitorMixin {
+  private attributeNames = new Map<string, HTMLAttributeNode[]>()
 
-class NoDuplicateAttributesVisitor extends BaseRuleVisitor {
   visitHTMLOpenTagNode(node: HTMLOpenTagNode): void {
-    this.checkDuplicateAttributes(node)
+    this.attributeNames.clear()
     super.visitHTMLOpenTagNode(node)
+    this.reportDuplicates()
   }
 
-  visitHTMLSelfCloseTagNode(node: HTMLSelfCloseTagNode): void {
-    this.checkDuplicateAttributes(node)
-    super.visitHTMLSelfCloseTagNode(node)
-  }
 
-  private checkDuplicateAttributes(node: HTMLOpenTagNode | HTMLSelfCloseTagNode): void {
-    const attributeNames = new Map<string, HTMLAttributeNameNode[]>()
-
-    forEachAttribute(node, (attributeNode) => {
-      if (attributeNode.name?.type !== "AST_HTML_ATTRIBUTE_NAME_NODE") return
-
-      const nameNode = attributeNode.name as HTMLAttributeNameNode
-      if (!nameNode.name) return
+  protected checkStaticAttributeStaticValue({ attributeName, attributeNode }: StaticAttributeStaticValueParams): void {
+    this.trackAttributeName(attributeName, attributeNode)
+  }
 
-      const attributeName = nameNode.name.value.toLowerCase() // HTML attributes are case-insensitive
+  protected checkStaticAttributeDynamicValue({ attributeName, attributeNode }: StaticAttributeDynamicValueParams): void {
+    this.trackAttributeName(attributeName, attributeNode)
+  }
 
-      if (!attributeNames.has(attributeName)) {
-        attributeNames.set(attributeName, [])
-      }
+  private trackAttributeName(attributeName: string, attributeNode: HTMLAttributeNode): void {
+    if (!this.attributeNames.has(attributeName)) {
+      this.attributeNames.set(attributeName, [])
+    }
 
-      attributeNames.get(attributeName)!.push(nameNode)
-    })
+    this.attributeNames.get(attributeName)!.push(attributeNode)
+  }
 
-    for (const [attributeName, nameNodes] of attributeNames) {
-      if (nameNodes.length > 1) {
-        for (let i = 1; i < nameNodes.length; i++) {
-          const nameNode = nameNodes[i]
+  private reportDuplicates(): void {
+    for (const [attributeName, attributeNodes] of this.attributeNames) {
+      if (attributeNodes.length > 1) {
+        for (let i = 1; i < attributeNodes.length; i++) {
+          const attributeNode = attributeNodes[i]
 
           this.addOffense(
             `Duplicate attribute \`${attributeName}\` found on tag. Remove the duplicate occurrence.`,
-            nameNode.location,
+            attributeNode.name!.location,
             "error"
           )
         }
@@ -52,9 +50,11 @@ class NoDuplicateAttributesVisitor extends BaseRuleVisitor {
 export class HTMLNoDuplicateAttributesRule extends ParserRule {
   name = "html-no-duplicate-attributes"
 
-  check(node: Node, context?: Partial<LintContext>): LintOffense[] {
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
     const visitor = new NoDuplicateAttributesVisitor(this.name, context)
-    visitor.visit(node)
+
+    visitor.visit(result.value)
+
     return visitor.offenses
   }
 }

package/src/rules/html-no-duplicate-ids.ts

@@ -1,12 +1,13 @@
-import { AttributeVisitorMixin } from "./rule-utils"
 import { ParserRule } from "../types"
-import type { Node } from "@herb-tools/core"
+import { AttributeVisitorMixin, StaticAttributeStaticValueParams } from "./rule-utils"
+
+import type { ParseResult } from "@herb-tools/core"
 import type { LintOffense, LintContext } from "../types"
 
 class NoDuplicateIdsVisitor extends AttributeVisitorMixin {
   private documentIds: Set<string> = new Set<string>()
 
-  protected checkAttribute(attributeName: string, attributeValue: string | null, attributeNode: Node): void {
+  protected checkStaticAttributeStaticValue({ attributeName, attributeValue, attributeNode }: StaticAttributeStaticValueParams): void {
     if (attributeName.toLowerCase() !== "id") return
     if (!attributeValue) return
 
@@ -29,10 +30,10 @@ class NoDuplicateIdsVisitor extends AttributeVisitorMixin {
 export class HTMLNoDuplicateIdsRule extends ParserRule {
   name = "html-no-duplicate-ids"
 
-  check(node: Node, context?: Partial<LintContext>): LintOffense[] {
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
     const visitor = new NoDuplicateIdsVisitor(this.name, context)
 
-    visitor.visit(node)
+    visitor.visit(result.value)
 
     return visitor.offenses
   }

package/src/rules/html-no-empty-headings.ts

@@ -2,7 +2,7 @@ import { BaseRuleVisitor, getTagName, getAttributes, findAttributeByName, getAtt
 
 import { ParserRule } from "../types.js"
 import type { LintOffense, LintContext } from "../types.js"
-import type { HTMLElementNode, HTMLOpenTagNode, HTMLSelfCloseTagNode, Node, LiteralNode, HTMLTextNode } from "@herb-tools/core"
+import type { HTMLElementNode, HTMLOpenTagNode, ParseResult, LiteralNode, HTMLTextNode } from "@herb-tools/core"
 
 class NoEmptyHeadingsVisitor extends BaseRuleVisitor {
   visitHTMLElementNode(node: HTMLElementNode): void {
@@ -10,10 +10,6 @@ class NoEmptyHeadingsVisitor extends BaseRuleVisitor {
     super.visitHTMLElementNode(node)
   }
 
-  visitHTMLSelfCloseTagNode(node: HTMLSelfCloseTagNode): void {
-    this.checkSelfClosingHeading(node)
-    super.visitHTMLSelfCloseTagNode(node)
-  }
 
   private checkHeadingElement(node: HTMLElementNode): void {
     if (!node.open_tag || node.open_tag.type !== "AST_HTML_OPEN_TAG_NODE") {
@@ -47,31 +43,6 @@ class NoEmptyHeadingsVisitor extends BaseRuleVisitor {
     }
   }
 
-  private checkSelfClosingHeading(node: HTMLSelfCloseTagNode): void {
-    const tagName = getTagName(node)
-    if (!tagName) {
-      return
-    }
-
-    // Check if it's a standard heading tag (h1-h6) or has role="heading"
-    const isStandardHeading = HEADING_TAGS.has(tagName)
-    const isAriaHeading = this.hasHeadingRole(node)
-
-    if (!isStandardHeading && !isAriaHeading) {
-      return
-    }
-
-    // Self-closing headings are always empty
-    const elementDescription = isStandardHeading
-      ? `\`<${tagName}>\``
-      : `\`<${tagName} role="heading">\``
-
-    this.addOffense(
-      `Heading element ${elementDescription} must not be empty. Provide accessible text content for screen readers and SEO.`,
-      node.tag_name!.location,
-      "error"
-    )
-  }
 
   private isEmptyHeading(node: HTMLElementNode): boolean {
     if (!node.body || node.body.length === 0) {
@@ -114,7 +85,7 @@ class NoEmptyHeadingsVisitor extends BaseRuleVisitor {
     return !hasAccessibleContent
   }
 
-  private hasHeadingRole(node: HTMLOpenTagNode | HTMLSelfCloseTagNode): boolean {
+  private hasHeadingRole(node: HTMLOpenTagNode): boolean {
     const attributes = getAttributes(node)
     const roleAttribute = findAttributeByName(attributes, "role")
 
@@ -178,9 +149,9 @@ class NoEmptyHeadingsVisitor extends BaseRuleVisitor {
 export class HTMLNoEmptyHeadingsRule extends ParserRule {
   name = "html-no-empty-headings"
 
-  check(node: Node, context?: Partial<LintContext>): LintOffense[] {
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
     const visitor = new NoEmptyHeadingsVisitor(this.name, context)
-    visitor.visit(node)
+    visitor.visit(result.value)
     return visitor.offenses
   }
 }

package/src/rules/html-no-nested-links.ts

@@ -2,7 +2,7 @@ import { BaseRuleVisitor, getTagName } from "./rule-utils.js"
 
 import { ParserRule } from "../types.js"
 import type { LintOffense, LintContext } from "../types.js"
-import type { HTMLOpenTagNode, HTMLElementNode, Node } from "@herb-tools/core"
+import type { HTMLOpenTagNode, HTMLElementNode, ParseResult } from "@herb-tools/core"
 
 class NestedLinkVisitor extends BaseRuleVisitor {
   private linkStack: HTMLOpenTagNode[] = []
@@ -58,9 +58,9 @@ class NestedLinkVisitor extends BaseRuleVisitor {
 export class HTMLNoNestedLinksRule extends ParserRule {
   name = "html-no-nested-links"
 
-  check(node: Node, context?: Partial<LintContext>): LintOffense[] {
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
     const visitor = new NestedLinkVisitor(this.name, context)
-    visitor.visit(node)
+    visitor.visit(result.value)
     return visitor.offenses
   }
 }

package/src/rules/html-no-positive-tab-index.ts

@@ -0,0 +1,33 @@
+import { ParserRule } from "../types.js"
+import { AttributeVisitorMixin, StaticAttributeStaticValueParams } from "./rule-utils.js"
+
+import type { LintOffense, LintContext } from "../types.js"
+import type { ParseResult } from "@herb-tools/core"
+
+class NoPositiveTabIndexVisitor extends AttributeVisitorMixin {
+  protected checkStaticAttributeStaticValue({ attributeName, attributeValue, attributeNode }: StaticAttributeStaticValueParams): void {
+    if (attributeName !== "tabindex") return
+
+    const tabIndexValue = parseInt(attributeValue, 10)
+
+    if (!isNaN(tabIndexValue) && tabIndexValue > 0) {
+      this.addOffense(
+        `Do not use positive \`tabindex\` values as they are error prone and can severely disrupt navigation experience for keyboard users. Use \`tabindex="0"\` to make an element focusable or \`tabindex=\"-1\"\` to remove it from the tab sequence.`,
+        attributeNode.location,
+        "error"
+      )
+    }
+  }
+}
+
+export class HTMLNoPositiveTabIndexRule extends ParserRule {
+  name = "html-no-positive-tab-index"
+
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
+    const visitor = new NoPositiveTabIndexVisitor(this.name, context)
+
+    visitor.visit(result.value)
+
+    return visitor.offenses
+  }
+}

package/src/rules/html-no-self-closing.ts

@@ -0,0 +1,36 @@
+import { ParserRule } from "../types.js"
+import { BaseRuleVisitor, getTagName, isVoidElement } from "./rule-utils.js"
+
+import type { LintContext, LintOffense } from "../types.js"
+import type { HTMLOpenTagNode, ParseResult } from "@herb-tools/core"
+
+class NoSelfClosingVisitor extends BaseRuleVisitor {
+  visitHTMLOpenTagNode(node: HTMLOpenTagNode): void {
+    if (node.tag_closing?.value === "/>") {
+      const tagName = getTagName(node)
+
+      const shouldBeVoid = tagName ? isVoidElement(tagName) : false
+      const instead = shouldBeVoid ? `Use \`<${tagName}>\` instead.` : `Use \`<${tagName}></${tagName}>\` instead.`
+
+      this.addOffense(
+        `Self-closing syntax \`<${tagName} />\` is not allowed in HTML. ${instead}`,
+        node.location,
+        "error"
+      )
+    }
+
+    super.visitHTMLOpenTagNode(node)
+  }
+}
+
+export class HTMLNoSelfClosingRule extends ParserRule {
+  name = "html-no-self-closing"
+
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
+    const visitor = new NoSelfClosingVisitor(this.name, context)
+
+    visitor.visit(result.value)
+
+    return visitor.offenses
+  }
+}

package/src/rules/html-no-title-attribute.ts

@@ -0,0 +1,42 @@
+import { ParserRule } from "../types.js"
+import { BaseRuleVisitor, getTagName, hasAttribute } from "./rule-utils.js"
+
+import type { LintOffense, LintContext } from "../types.js"
+import type { HTMLOpenTagNode, ParseResult } from "@herb-tools/core"
+
+class NoTitleAttributeVisitor extends BaseRuleVisitor {
+  ALLOWED_ELEMENTS_WITH_TITLE = new Set(["iframe", "link"])
+
+  visitHTMLOpenTagNode(node: HTMLOpenTagNode): void {
+    this.checkTitleAttribute(node)
+    super.visitHTMLOpenTagNode(node)
+  }
+
+  private checkTitleAttribute(node: HTMLOpenTagNode): void {
+    const tagName = getTagName(node)
+
+    if (!tagName || this.ALLOWED_ELEMENTS_WITH_TITLE.has(tagName)) {
+      return
+    }
+
+    if (hasAttribute(node, "title")) {
+      this.addOffense(
+        "The `title` attribute should never be used as it is inaccessible for several groups of users. Use `aria-label` or `aria-describedby` instead. Exceptions are provided for `<iframe>` and `<link>` elements.",
+        node.tag_name!.location,
+        "error"
+      )
+    }
+  }
+}
+
+export class HTMLNoTitleAttributeRule extends ParserRule {
+  name = "html-no-title-attribute"
+
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
+    const visitor = new NoTitleAttributeVisitor(this.name, context)
+
+    visitor.visit(result.value)
+
+    return visitor.offenses
+  }
+}

package/src/rules/html-tag-name-lowercase.ts

@@ -1,53 +1,56 @@
+import { ParserRule } from "../types.js"
 import { BaseRuleVisitor } from "./rule-utils.js"
 
-import { ParserRule } from "../types.js"
+import { isNode, getTagName, HTMLElementNode, HTMLOpenTagNode, HTMLCloseTagNode, ParseResult, XMLDeclarationNode, Node } from "@herb-tools/core"
+
 import type { LintOffense, LintContext } from "../types.js"
-import type { HTMLElementNode, HTMLOpenTagNode, HTMLCloseTagNode, HTMLSelfCloseTagNode, Node } from "@herb-tools/core"
 
-class TagNameLowercaseVisitor extends BaseRuleVisitor {
-  visitHTMLElementNode(node: HTMLElementNode): void {
-    const tagName = node.tag_name?.value
+class XMLDeclarationChecker extends BaseRuleVisitor {
+  hasXMLDeclaration: boolean = false
 
-    if (node.open_tag) {
-      this.checkTagName(node.open_tag as HTMLOpenTagNode)
-    }
+  visitXMLDeclarationNode(_node: XMLDeclarationNode): void {
+    this.hasXMLDeclaration = true
+  }
 
-    if (tagName && ["svg"].includes(tagName.toLowerCase())) {
-      if (node.close_tag) {
-        this.checkTagName(node.close_tag as HTMLCloseTagNode)
-      }
+  visitChildNodes(node: Node): void {
+    if (this.hasXMLDeclaration) return
+    super.visitChildNodes(node)
+  }
+}
 
-      return
+class TagNameLowercaseVisitor extends BaseRuleVisitor {
+  visitHTMLElementNode(node: HTMLElementNode): void {
+    if (getTagName(node).toLowerCase() === "svg") {
+      this.checkTagName(node.open_tag)
+      this.checkTagName(node.close_tag)
+    } else {
+      super.visitHTMLElementNode(node)
     }
+  }
 
-    this.visitChildNodes(node)
-
-    if (node.close_tag) {
-      this.checkTagName(node.close_tag as HTMLCloseTagNode)
-    }
+  visitHTMLOpenTagNode(node: HTMLOpenTagNode) {
+    this.checkTagName(node)
   }
 
-  visitHTMLSelfCloseTagNode(node: HTMLSelfCloseTagNode): void {
+  visitHTMLCloseTagNode(node: HTMLCloseTagNode) {
     this.checkTagName(node)
-    this.visitChildNodes(node)
   }
 
-  private checkTagName(node: HTMLOpenTagNode | HTMLCloseTagNode | HTMLSelfCloseTagNode): void {
-    const tagName = node.tag_name?.value
+  private checkTagName(node: HTMLOpenTagNode | HTMLCloseTagNode | null): void {
+    if (!node) return
+
+    const tagName = getTagName(node)
 
     if (!tagName) return
 
     const lowercaseTagName = tagName.toLowerCase()
 
-    if (tagName !== lowercaseTagName) {
-      let type: string = node.type
-
-      if (node.type == "AST_HTML_OPEN_TAG_NODE") type = "Opening"
-      if (node.type == "AST_HTML_CLOSE_TAG_NODE") type = "Closing"
-      if (node.type == "AST_HTML_SELF_CLOSE_TAG_NODE") type = "Self-closing"
+    const type = isNode(node, HTMLOpenTagNode) ? "Opening" : "Closing"
+    const open = isNode(node, HTMLOpenTagNode) ? "<" : "</"
 
+    if (tagName !== lowercaseTagName) {
       this.addOffense(
-        `${type} tag name \`${tagName}\` should be lowercase. Use \`${lowercaseTagName}\` instead.`,
+        `${type} tag name \`${open}${tagName}>\` should be lowercase. Use \`${open}${lowercaseTagName}>\` instead.`,
         node.tag_name!.location,
         "error"
       )
@@ -58,9 +61,19 @@ class TagNameLowercaseVisitor extends BaseRuleVisitor {
 export class HTMLTagNameLowercaseRule extends ParserRule {
   name = "html-tag-name-lowercase"
 
-  check(node: Node, context?: Partial<LintContext>): LintOffense[] {
+  isEnabled(result: ParseResult, context?: Partial<LintContext>): boolean {
+    if (context?.fileName?.endsWith(".xml") || context?.fileName?.endsWith(".xml.erb")) {
+      return false
+    }
+
+    const checker = new XMLDeclarationChecker(this.name)
+    checker.visit(result.value)
+    return !checker.hasXMLDeclaration
+  }
+
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
     const visitor = new TagNameLowercaseVisitor(this.name, context)
-    visitor.visit(node)
+    visitor.visit(result.value)
     return visitor.offenses
   }
 }

package/src/rules/index.ts

@@ -1,19 +1,29 @@
 export * from "./erb-no-empty-tags.js"
 export * from "./erb-no-output-control-flow.js"
+export * from "./erb-no-silent-tag-in-attribute-name.js"
 export * from "./erb-prefer-image-tag-helper.js"
 export * from "./erb-requires-trailing-newline.js"
 export * from "./html-anchor-require-href.js"
+export * from "./html-aria-label-is-well-formatted.js"
 export * from "./html-aria-level-must-be-valid.js"
 export * from "./html-aria-role-heading-requires-level.js"
 export * from "./html-aria-role-must-be-valid.js"
 export * from "./html-attribute-double-quotes.js"
+export * from "./html-attribute-equals-spacing.js"
 export * from "./html-attribute-values-require-quotes.js"
+export * from "./html-avoid-both-disabled-and-aria-disabled.js"
 export * from "./html-boolean-attributes-no-value.js"
+export * from "./html-iframe-has-title.js"
 export * from "./html-img-require-alt.js"
+export * from "./html-navigation-has-label.js"
+export * from "./html-no-aria-hidden-on-focusable.js"
 export * from "./html-no-block-inside-inline.js"
 export * from "./html-no-duplicate-attributes.js"
 export * from "./html-no-duplicate-ids.js"
 export * from "./html-no-empty-headings.js"
 export * from "./html-no-nested-links.js"
+export * from "./html-no-positive-tab-index.js"
+export * from "./html-no-self-closing.js"
+export * from "./html-no-title-attribute.js"
 export * from "./html-tag-name-lowercase.js"
 export * from "./svg-tag-name-capitalization.js"

package/src/rules/parser-no-errors.ts

@@ -0,0 +1,25 @@
+import { ParserRule } from "../types.js"
+
+import type { LintOffense } from "../types.js"
+import type { ParseResult, HerbError } from "@herb-tools/core"
+
+export class ParserNoErrorsRule extends ParserRule {
+  name = "parser-no-errors"
+
+  check(result: ParseResult): LintOffense[] {
+    return result.recursiveErrors().map(error =>
+      this.herbErrorToLintOffense(error)
+    )
+  }
+
+  private herbErrorToLintOffense(error: HerbError): LintOffense {
+    return {
+      message: `${error.message} (\`${error.type}\`)`,
+      location: error.location,
+      severity: error.severity,
+      rule: this.name,
+      code: this.name,
+      source: "linter"
+    }
+  }
+}