@herb-tools/linter 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/dist/herb-lint.js +5131 -1647
  2. package/dist/herb-lint.js.map +1 -1
  3. package/dist/index.cjs +662 -145
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.js +654 -147
  6. package/dist/index.js.map +1 -1
  7. package/dist/package.json +4 -4
  8. package/dist/src/cli/argument-parser.js +0 -4
  9. package/dist/src/cli/argument-parser.js.map +1 -1
  10. package/dist/src/default-rules.js +20 -0
  11. package/dist/src/default-rules.js.map +1 -1
  12. package/dist/src/linter.js +29 -4
  13. package/dist/src/linter.js.map +1 -1
  14. package/dist/src/rules/erb-no-silent-tag-in-attribute-name.js +26 -0
  15. package/dist/src/rules/erb-no-silent-tag-in-attribute-name.js.map +1 -0
  16. package/dist/src/rules/erb-prefer-image-tag-helper.js +0 -4
  17. package/dist/src/rules/erb-prefer-image-tag-helper.js.map +1 -1
  18. package/dist/src/rules/html-aria-attribute-must-be-valid.js +11 -10
  19. package/dist/src/rules/html-aria-attribute-must-be-valid.js.map +1 -1
  20. package/dist/src/rules/html-aria-label-is-well-formatted.js +33 -0
  21. package/dist/src/rules/html-aria-label-is-well-formatted.js.map +1 -0
  22. package/dist/src/rules/html-aria-level-must-be-valid.js +26 -4
  23. package/dist/src/rules/html-aria-level-must-be-valid.js.map +1 -1
  24. package/dist/src/rules/html-aria-role-heading-requires-level.js +7 -13
  25. package/dist/src/rules/html-aria-role-heading-requires-level.js.map +1 -1
  26. package/dist/src/rules/html-aria-role-must-be-valid.js +3 -3
  27. package/dist/src/rules/html-aria-role-must-be-valid.js.map +1 -1
  28. package/dist/src/rules/html-attribute-double-quotes.js +14 -4
  29. package/dist/src/rules/html-attribute-double-quotes.js.map +1 -1
  30. package/dist/src/rules/html-attribute-equals-spacing.js +24 -0
  31. package/dist/src/rules/html-attribute-equals-spacing.js.map +1 -0
  32. package/dist/src/rules/html-attribute-values-require-quotes.js +19 -8
  33. package/dist/src/rules/html-attribute-values-require-quotes.js.map +1 -1
  34. package/dist/src/rules/html-avoid-both-disabled-and-aria-disabled.js +47 -0
  35. package/dist/src/rules/html-avoid-both-disabled-and-aria-disabled.js.map +1 -0
  36. package/dist/src/rules/html-boolean-attributes-no-value.js +9 -2
  37. package/dist/src/rules/html-boolean-attributes-no-value.js.map +1 -1
  38. package/dist/src/rules/html-iframe-has-title.js +39 -0
  39. package/dist/src/rules/html-iframe-has-title.js.map +1 -0
  40. package/dist/src/rules/html-img-require-alt.js +0 -4
  41. package/dist/src/rules/html-img-require-alt.js.map +1 -1
  42. package/dist/src/rules/html-navigation-has-label.js +43 -0
  43. package/dist/src/rules/html-navigation-has-label.js.map +1 -0
  44. package/dist/src/rules/html-no-aria-hidden-on-focusable.js +67 -0
  45. package/dist/src/rules/html-no-aria-hidden-on-focusable.js.map +1 -0
  46. package/dist/src/rules/html-no-duplicate-attributes.js +22 -25
  47. package/dist/src/rules/html-no-duplicate-attributes.js.map +1 -1
  48. package/dist/src/rules/html-no-duplicate-ids.js +2 -2
  49. package/dist/src/rules/html-no-duplicate-ids.js.map +1 -1
  50. package/dist/src/rules/html-no-empty-headings.js +0 -21
  51. package/dist/src/rules/html-no-empty-headings.js.map +1 -1
  52. package/dist/src/rules/html-no-positive-tab-index.js +21 -0
  53. package/dist/src/rules/html-no-positive-tab-index.js.map +1 -0
  54. package/dist/src/rules/html-no-self-closing.js +22 -0
  55. package/dist/src/rules/html-no-self-closing.js.map +1 -0
  56. package/dist/src/rules/html-no-title-attribute.js +27 -0
  57. package/dist/src/rules/html-no-title-attribute.js.map +1 -0
  58. package/dist/src/rules/html-tag-name-lowercase.js +35 -23
  59. package/dist/src/rules/html-tag-name-lowercase.js.map +1 -1
  60. package/dist/src/rules/index.js +10 -0
  61. package/dist/src/rules/index.js.map +1 -1
  62. package/dist/src/rules/rule-utils.js +176 -22
  63. package/dist/src/rules/rule-utils.js.map +1 -1
  64. package/dist/src/rules/svg-tag-name-capitalization.js +0 -8
  65. package/dist/src/rules/svg-tag-name-capitalization.js.map +1 -1
  66. package/dist/src/types.js.map +1 -1
  67. package/dist/tsconfig.tsbuildinfo +1 -1
  68. package/dist/types/cli/index.d.ts +4 -0
  69. package/dist/types/rules/erb-no-silent-tag-in-attribute-name.d.ts +7 -0
  70. package/dist/types/rules/html-aria-label-is-well-formatted.d.ts +7 -0
  71. package/dist/types/rules/html-attribute-equals-spacing.d.ts +7 -0
  72. package/dist/types/rules/html-avoid-both-disabled-and-aria-disabled.d.ts +7 -0
  73. package/dist/types/rules/html-iframe-has-title.d.ts +7 -0
  74. package/dist/types/rules/html-navigation-has-label.d.ts +7 -0
  75. package/dist/types/rules/html-no-aria-hidden-on-focusable.d.ts +7 -0
  76. package/dist/types/rules/html-no-positive-tab-index.d.ts +7 -0
  77. package/dist/types/rules/html-no-self-closing.d.ts +7 -0
  78. package/dist/types/rules/html-no-title-attribute.d.ts +7 -0
  79. package/dist/types/rules/html-tag-name-lowercase.d.ts +2 -1
  80. package/dist/types/rules/index.d.ts +10 -0
  81. package/dist/types/rules/rule-utils.d.ts +107 -13
  82. package/dist/types/src/rules/erb-no-silent-tag-in-attribute-name.d.ts +7 -0
  83. package/dist/types/src/rules/html-aria-label-is-well-formatted.d.ts +7 -0
  84. package/dist/types/src/rules/html-attribute-equals-spacing.d.ts +7 -0
  85. package/dist/types/src/rules/html-avoid-both-disabled-and-aria-disabled.d.ts +7 -0
  86. package/dist/types/src/rules/html-iframe-has-title.d.ts +7 -0
  87. package/dist/types/src/rules/html-navigation-has-label.d.ts +7 -0
  88. package/dist/types/src/rules/html-no-aria-hidden-on-focusable.d.ts +7 -0
  89. package/dist/types/src/rules/html-no-positive-tab-index.d.ts +7 -0
  90. package/dist/types/src/rules/html-no-self-closing.d.ts +7 -0
  91. package/dist/types/src/rules/html-no-title-attribute.d.ts +7 -0
  92. package/dist/types/src/rules/html-tag-name-lowercase.d.ts +2 -1
  93. package/dist/types/src/rules/index.d.ts +10 -0
  94. package/dist/types/src/rules/rule-utils.d.ts +107 -13
  95. package/dist/types/src/types.d.ts +24 -0
  96. package/dist/types/types.d.ts +24 -0
  97. package/docs/rules/README.md +12 -2
  98. package/docs/rules/erb-no-silent-tag-in-attribute-name.md +34 -0
  99. package/docs/rules/html-aria-label-is-well-formatted.md +49 -0
  100. package/docs/rules/html-attribute-equals-spacing.md +35 -0
  101. package/docs/rules/html-avoid-both-disabled-and-aria-disabled.md +48 -0
  102. package/docs/rules/html-iframe-has-title.md +43 -0
  103. package/docs/rules/html-navigation-has-label.md +61 -0
  104. package/docs/rules/html-no-aria-hidden-on-focusable.md +54 -0
  105. package/docs/rules/html-no-positive-tab-index.md +55 -0
  106. package/docs/rules/html-no-self-closing.md +65 -0
  107. package/docs/rules/html-no-title-attribute.md +69 -0
  108. package/docs/rules/html-tag-name-lowercase.md +16 -3
  109. package/package.json +4 -4
  110. package/src/cli/argument-parser.ts +0 -5
  111. package/src/default-rules.ts +20 -0
  112. package/src/linter.ts +30 -4
  113. package/src/rules/erb-no-silent-tag-in-attribute-name.ts +40 -0
  114. package/src/rules/erb-prefer-image-tag-helper.ts +2 -7
  115. package/src/rules/html-aria-attribute-must-be-valid.ts +28 -32
  116. package/src/rules/html-aria-label-is-well-formatted.ts +59 -0
  117. package/src/rules/html-aria-level-must-be-valid.ts +38 -5
  118. package/src/rules/html-aria-role-heading-requires-level.ts +16 -28
  119. package/src/rules/html-aria-role-must-be-valid.ts +5 -5
  120. package/src/rules/html-attribute-double-quotes.ts +21 -6
  121. package/src/rules/html-attribute-equals-spacing.ts +41 -0
  122. package/src/rules/html-attribute-values-require-quotes.ts +29 -9
  123. package/src/rules/html-avoid-both-disabled-and-aria-disabled.ts +66 -0
  124. package/src/rules/html-boolean-attributes-no-value.ts +17 -4
  125. package/src/rules/html-iframe-has-title.ts +62 -0
  126. package/src/rules/html-img-require-alt.ts +2 -7
  127. package/src/rules/html-navigation-has-label.ts +64 -0
  128. package/src/rules/html-no-aria-hidden-on-focusable.ts +90 -0
  129. package/src/rules/html-no-duplicate-attributes.ts +28 -28
  130. package/src/rules/html-no-duplicate-ids.ts +4 -3
  131. package/src/rules/html-no-empty-headings.ts +2 -31
  132. package/src/rules/html-no-positive-tab-index.ts +33 -0
  133. package/src/rules/html-no-self-closing.ts +36 -0
  134. package/src/rules/html-no-title-attribute.ts +42 -0
  135. package/src/rules/html-tag-name-lowercase.ts +42 -29
  136. package/src/rules/index.ts +10 -0
  137. package/src/rules/rule-utils.ts +260 -39
  138. package/src/rules/svg-tag-name-capitalization.ts +2 -9
  139. package/src/types.ts +27 -0
@@ -1,5 +1,5 @@
1
1
  import { Visitor, Location } from "@herb-tools/core";
2
- import type { HTMLAttributeNode, HTMLOpenTagNode, HTMLSelfCloseTagNode, LexResult, Token } from "@herb-tools/core";
2
+ import type { HTMLAttributeNode, HTMLAttributeValueNode, HTMLOpenTagNode, LexResult, Token, Node } from "@herb-tools/core";
3
3
  import type { LintOffense, LintSeverity, LintContext } from "../types.js";
4
4
  /**
5
5
  * Base visitor class that provides common functionality for rule visitors
@@ -19,17 +19,52 @@ export declare abstract class BaseRuleVisitor extends Visitor {
19
19
  protected addOffense(message: string, location: Location, severity?: LintSeverity): void;
20
20
  }
21
21
  /**
22
- * Gets attributes from either an HTMLOpenTagNode or HTMLSelfCloseTagNode
22
+ * Gets attributes from an HTMLOpenTagNode
23
23
  */
24
- export declare function getAttributes(node: HTMLOpenTagNode | HTMLSelfCloseTagNode): any[];
24
+ export declare function getAttributes(node: HTMLOpenTagNode): HTMLAttributeNode[];
25
25
  /**
26
26
  * Gets the tag name from an HTML tag node (lowercased)
27
27
  */
28
- export declare function getTagName(node: HTMLOpenTagNode | HTMLSelfCloseTagNode): string | null;
28
+ export declare function getTagName(node: HTMLOpenTagNode): string | null;
29
29
  /**
30
30
  * Gets the attribute name from an HTMLAttributeNode (lowercased)
31
+ * Returns null if the attribute name contains dynamic content (ERB)
31
32
  */
32
33
  export declare function getAttributeName(attributeNode: HTMLAttributeNode): string | null;
34
+ /**
35
+ * Checks if an attribute has a dynamic (ERB-containing) name
36
+ */
37
+ export declare function hasDynamicAttributeName(attributeNode: HTMLAttributeNode): boolean;
38
+ /**
39
+ * Gets the combined string representation of an attribute name (for debugging)
40
+ * This includes both static content and ERB syntax
41
+ */
42
+ export declare function getCombinedAttributeNameString(attributeNode: HTMLAttributeNode): string;
43
+ /**
44
+ * Checks if an attribute value contains only static content (no ERB)
45
+ */
46
+ export declare function hasStaticAttributeValue(attributeNode: HTMLAttributeNode): boolean;
47
+ /**
48
+ * Checks if an attribute value contains dynamic content (ERB)
49
+ */
50
+ export declare function hasDynamicAttributeValue(attributeNode: HTMLAttributeNode): boolean;
51
+ /**
52
+ * Gets the static string value of an attribute (returns null if it contains ERB)
53
+ */
54
+ export declare function getStaticAttributeValue(attributeNode: HTMLAttributeNode): string | null;
55
+ /**
56
+ * Gets the value nodes array for dynamic inspection
57
+ */
58
+ export declare function getAttributeValueNodes(attributeNode: HTMLAttributeNode): Node[];
59
+ /**
60
+ * Checks if an attribute value contains any static content (for validation purposes)
61
+ */
62
+ export declare function hasStaticAttributeValueContent(attributeNode: HTMLAttributeNode): boolean;
63
+ /**
64
+ * Gets the static content of an attribute value (all literal parts combined)
65
+ * Returns the concatenated literal content, or null if no literal nodes exist
66
+ */
67
+ export declare function getStaticAttributeValueContent(attributeNode: HTMLAttributeNode): string | null;
33
68
  /**
34
69
  * Gets the attribute value content from an HTMLAttributeValueNode
35
70
  */
@@ -41,20 +76,25 @@ export declare function hasAttributeValue(attributeNode: HTMLAttributeNode): boo
41
76
  /**
42
77
  * Gets the quote type used for an attribute value
43
78
  */
44
- export declare function getAttributeValueQuoteType(attributeNode: HTMLAttributeNode): "single" | "double" | "none" | null;
79
+ export declare function getAttributeValueQuoteType(nodeOrAttribute: HTMLAttributeNode | HTMLAttributeValueNode): "single" | "double" | "none" | null;
45
80
  /**
46
81
  * Finds an attribute by name in a list of attributes
47
82
  */
48
- export declare function findAttributeByName(attributes: any[], attributeName: string): HTMLAttributeNode | null;
83
+ export declare function findAttributeByName(attributes: Node[], attributeName: string): HTMLAttributeNode | null;
49
84
  /**
50
85
  * Checks if a tag has a specific attribute
51
86
  */
52
- export declare function hasAttribute(node: HTMLOpenTagNode | HTMLSelfCloseTagNode, attributeName: string): boolean;
87
+ export declare function hasAttribute(node: HTMLOpenTagNode, attributeName: string): boolean;
88
+ /**
89
+ * Checks if a tag has a specific attribute
90
+ */
91
+ export declare function getAttribute(node: HTMLOpenTagNode, attributeName: string): HTMLAttributeNode | null;
53
92
  /**
54
93
  * Common HTML element categorization
55
94
  */
56
95
  export declare const HTML_INLINE_ELEMENTS: Set<string>;
57
96
  export declare const HTML_BLOCK_ELEMENTS: Set<string>;
97
+ export declare const HTML_VOID_ELEMENTS: Set<string>;
58
98
  export declare const HTML_BOOLEAN_ATTRIBUTES: Set<string>;
59
99
  export declare const HEADING_TAGS: Set<string>;
60
100
  /**
@@ -67,6 +107,37 @@ export declare const SVG_CAMEL_CASE_ELEMENTS: Set<string>;
67
107
  */
68
108
  export declare const SVG_LOWERCASE_TO_CAMELCASE: Map<string, string>;
69
109
  export declare const VALID_ARIA_ROLES: Set<string>;
110
+ /**
111
+ * Parameter types for AttributeVisitorMixin methods
112
+ */
113
+ export interface StaticAttributeStaticValueParams {
114
+ attributeName: string;
115
+ attributeValue: string;
116
+ attributeNode: HTMLAttributeNode;
117
+ parentNode: HTMLOpenTagNode;
118
+ }
119
+ export interface StaticAttributeDynamicValueParams {
120
+ attributeName: string;
121
+ valueNodes: Node[];
122
+ attributeNode: HTMLAttributeNode;
123
+ parentNode: HTMLOpenTagNode;
124
+ combinedValue?: string | null;
125
+ }
126
+ export interface DynamicAttributeStaticValueParams {
127
+ nameNodes: Node[];
128
+ attributeValue: string;
129
+ attributeNode: HTMLAttributeNode;
130
+ parentNode: HTMLOpenTagNode;
131
+ combinedName?: string;
132
+ }
133
+ export interface DynamicAttributeDynamicValueParams {
134
+ nameNodes: Node[];
135
+ valueNodes: Node[];
136
+ attributeNode: HTMLAttributeNode;
137
+ parentNode: HTMLOpenTagNode;
138
+ combinedName?: string;
139
+ combinedValue?: string | null;
140
+ }
70
141
  export declare const ARIA_ATTRIBUTES: Set<string>;
71
142
  /**
72
143
  * Helper function to create a location at the end of the source with a 1-character range
@@ -80,21 +151,44 @@ export declare function isInlineElement(tagName: string): boolean;
80
151
  * Checks if an element is block-level
81
152
  */
82
153
  export declare function isBlockElement(tagName: string): boolean;
154
+ /**
155
+ * Checks if an element is a void element
156
+ */
157
+ export declare function isVoidElement(tagName: string): boolean;
83
158
  /**
84
159
  * Checks if an attribute is a boolean attribute
85
160
  */
86
161
  export declare function isBooleanAttribute(attributeName: string): boolean;
87
162
  /**
88
- * Abstract base class for rules that need to check individual attributes on HTML tags
89
- * Eliminates duplication of visitHTMLOpenTagNode/visitHTMLSelfCloseTagNode patterns
90
- * and attribute iteration logic. Provides simplified interface with extracted attribute info.
163
+ * Attribute visitor that provides granular processing based on both
164
+ * attribute name type (static/dynamic) and value type (static/dynamic)
165
+ *
166
+ * This gives you 4 distinct methods to override:
167
+ * - checkStaticAttributeStaticValue() - name="class" value="foo"
168
+ * - checkStaticAttributeDynamicValue() - name="class" value="<%= css_class %>"
169
+ * - checkDynamicAttributeStaticValue() - name="data-<%= key %>" value="foo"
170
+ * - checkDynamicAttributeDynamicValue() - name="data-<%= key %>" value="<%= value %>"
91
171
  */
92
172
  export declare abstract class AttributeVisitorMixin extends BaseRuleVisitor {
93
173
  constructor(ruleName: string, context?: Partial<LintContext>);
94
174
  visitHTMLOpenTagNode(node: HTMLOpenTagNode): void;
95
- visitHTMLSelfCloseTagNode(node: HTMLSelfCloseTagNode): void;
96
175
  private checkAttributesOnNode;
97
- protected abstract checkAttribute(attributeName: string, attributeValue: string | null, attributeNode: HTMLAttributeNode, parentNode: HTMLOpenTagNode | HTMLSelfCloseTagNode): void;
176
+ /**
177
+ * Static attribute name with static value: class="container"
178
+ */
179
+ protected checkStaticAttributeStaticValue(params: StaticAttributeStaticValueParams): void;
180
+ /**
181
+ * Static attribute name with dynamic value: class="<%= css_class %>"
182
+ */
183
+ protected checkStaticAttributeDynamicValue(params: StaticAttributeDynamicValueParams): void;
184
+ /**
185
+ * Dynamic attribute name with static value: data-<%= key %>="foo"
186
+ */
187
+ protected checkDynamicAttributeStaticValue(params: DynamicAttributeStaticValueParams): void;
188
+ /**
189
+ * Dynamic attribute name with dynamic value: data-<%= key %>="<%= value %>"
190
+ */
191
+ protected checkDynamicAttributeDynamicValue(params: DynamicAttributeDynamicValueParams): void;
98
192
  }
99
193
  /**
100
194
  * Checks if an attribute value is quoted
@@ -103,7 +197,7 @@ export declare function isAttributeValueQuoted(attributeNode: HTMLAttributeNode)
103
197
  /**
104
198
  * Iterates over all attributes of a tag node, calling the callback for each attribute
105
199
  */
106
- export declare function forEachAttribute(node: HTMLOpenTagNode | HTMLSelfCloseTagNode, callback: (attributeNode: HTMLAttributeNode) => void): void;
200
+ export declare function forEachAttribute(node: HTMLOpenTagNode, callback: (attributeNode: HTMLAttributeNode) => void): void;
107
201
  /**
108
202
  * Base lexer visitor class that provides common functionality for lexer-based rule visitors
109
203
  */
@@ -19,11 +19,27 @@ export declare abstract class ParserRule {
19
19
  static type: "parser";
20
20
  abstract name: string;
21
21
  abstract check(result: ParseResult, context?: Partial<LintContext>): LintOffense[];
22
+ /**
23
+ * Optional method to determine if this rule should run.
24
+ * If not implemented, rule is always enabled.
25
+ * @param result - The parse result to analyze
26
+ * @param context - Optional context for linting
27
+ * @returns true if rule should run, false to skip
28
+ */
29
+ isEnabled?(result: ParseResult, context?: Partial<LintContext>): boolean;
22
30
  }
23
31
  export declare abstract class LexerRule {
24
32
  static type: "lexer";
25
33
  abstract name: string;
26
34
  abstract check(lexResult: LexResult, context?: Partial<LintContext>): LintOffense[];
35
+ /**
36
+ * Optional method to determine if this rule should run.
37
+ * If not implemented, rule is always enabled.
38
+ * @param lexResult - The lex result to analyze
39
+ * @param context - Optional context for linting
40
+ * @returns true if rule should run, false to skip
41
+ */
42
+ isEnabled?(lexResult: LexResult, context?: Partial<LintContext>): boolean;
27
43
  }
28
44
  export interface LexerRuleConstructor {
29
45
  type: "lexer";
@@ -44,6 +60,14 @@ export declare abstract class SourceRule {
44
60
  static type: "source";
45
61
  abstract name: string;
46
62
  abstract check(source: string, context?: Partial<LintContext>): LintOffense[];
63
+ /**
64
+ * Optional method to determine if this rule should run.
65
+ * If not implemented, rule is always enabled.
66
+ * @param source - The source code to analyze
67
+ * @param context - Optional context for linting
68
+ * @returns true if rule should run, false to skip
69
+ */
70
+ isEnabled?(source: string, context?: Partial<LintContext>): boolean;
47
71
  }
48
72
  export interface SourceRuleConstructor {
49
73
  type: "source";
@@ -19,11 +19,27 @@ export declare abstract class ParserRule {
19
19
  static type: "parser";
20
20
  abstract name: string;
21
21
  abstract check(result: ParseResult, context?: Partial<LintContext>): LintOffense[];
22
+ /**
23
+ * Optional method to determine if this rule should run.
24
+ * If not implemented, rule is always enabled.
25
+ * @param result - The parse result to analyze
26
+ * @param context - Optional context for linting
27
+ * @returns true if rule should run, false to skip
28
+ */
29
+ isEnabled?(result: ParseResult, context?: Partial<LintContext>): boolean;
22
30
  }
23
31
  export declare abstract class LexerRule {
24
32
  static type: "lexer";
25
33
  abstract name: string;
26
34
  abstract check(lexResult: LexResult, context?: Partial<LintContext>): LintOffense[];
35
+ /**
36
+ * Optional method to determine if this rule should run.
37
+ * If not implemented, rule is always enabled.
38
+ * @param lexResult - The lex result to analyze
39
+ * @param context - Optional context for linting
40
+ * @returns true if rule should run, false to skip
41
+ */
42
+ isEnabled?(lexResult: LexResult, context?: Partial<LintContext>): boolean;
27
43
  }
28
44
  export interface LexerRuleConstructor {
29
45
  type: "lexer";
@@ -44,6 +60,14 @@ export declare abstract class SourceRule {
44
60
  static type: "source";
45
61
  abstract name: string;
46
62
  abstract check(source: string, context?: Partial<LintContext>): LintOffense[];
63
+ /**
64
+ * Optional method to determine if this rule should run.
65
+ * If not implemented, rule is always enabled.
66
+ * @param source - The source code to analyze
67
+ * @param context - Optional context for linting
68
+ * @returns true if rule should run, false to skip
69
+ */
70
+ isEnabled?(source: string, context?: Partial<LintContext>): boolean;
47
71
  }
48
72
  export interface SourceRuleConstructor {
49
73
  type: "source";
@@ -6,22 +6,32 @@ This page contains documentation for all Herb Linter rules.
6
6
 
7
7
  - [`erb-no-empty-tags`](./erb-no-empty-tags.md) - Disallow empty ERB tags
8
8
  - [`erb-no-output-control-flow`](./erb-no-output-control-flow.md) - Prevents outputting control flow blocks
9
+ - [`erb-no-silent-tag-in-attribute-name`](./erb-no-silent-tag-in-attribute-name.md) - Disallow ERB silent tags in HTML attribute names
9
10
  - [`erb-prefer-image-tag-helper`](./erb-prefer-image-tag-helper.md) - Prefer `image_tag` helper over `<img>` with ERB expressions
10
- - [`erb-require-whitespace-inside-tags`](./erb-require-whitespace-inside-tags.md) - Requires whitespace around erb tags
11
+ - [`erb-require-whitespace-inside-tags`](./erb-require-whitespace-inside-tags.md) - Requires whitespace around ERB tags
11
12
  - [`erb-requires-trailing-newline`](./erb-requires-trailing-newline.md) - Enforces that all HTML+ERB template files end with exactly one trailing newline character.
12
13
  - [`html-anchor-require-href`](./html-anchor-require-href.md) - Requires an href attribute on anchor tags
13
14
  - [`html-aria-attribute-must-be-valid`](./html-aria-attribute-must-be-valid.md) - Disallow invalid or unknown `aria-*` attributes.
15
+ - [`html-aria-label-is-well-formatted`](./html-aria-label-is-well-formatted.md) - `aria-label` must be well-formatted
14
16
  - [`html-aria-level-must-be-valid`](./html-aria-level-must-be-valid.md) - `aria-level` must be between 1 and 6
15
17
  - [`html-aria-role-heading-requires-level`](./html-aria-role-heading-requires-level.md) - Requires `aria-level` when supplying a `role`
16
18
  - [`html-aria-role-must-be-valid`](./html-aria-role-must-be-valid.md) - The `role` attribute must have a valid WAI-ARIA Role.
17
19
  - [`html-attribute-double-quotes`](./html-attribute-double-quotes.md) - Enforces double quotes for attribute values
20
+ - [`html-attribute-equals-spacing`](./html-attribute-equals-spacing.md) - No whitespace around `=` in HTML attributes
18
21
  - [`html-attribute-values-require-quotes`](./html-attribute-values-require-quotes.md) - Requires quotes around attribute values
22
+ - [`html-avoid-both-disabled-and-aria-disabled`](./html-avoid-both-disabled-and-aria-disabled.md) - Avoid using both `disabled` and `aria-disabled` attributes
19
23
  - [`html-boolean-attributes-no-value`](./html-boolean-attributes-no-value.md) - Prevents values on boolean attributes
20
- - [`html-img-require-alt`](./html-img-require-alt.md) - Requires alt attributes on img tags
24
+ - [`html-iframe-has-title`](./html-iframe-has-title.md) - `iframe` elements must have a `title` attribute
25
+ - [`html-img-require-alt`](./html-img-require-alt.md) - Requires `alt` attributes on `<img>` tags
26
+ - [`html-navigation-has-label`](./html-navigation-has-label.md) - Navigation landmarks must have accessible labels
27
+ - [`html-no-aria-hidden-on-focusable`](./html-no-aria-hidden-on-focusable.md) - Focusable elements should not have `aria-hidden="true"`
21
28
  - [`html-no-block-inside-inline`](./html-no-block-inside-inline.md) - Prevents block-level elements inside inline elements
22
29
  - [`html-no-duplicate-attributes`](./html-no-duplicate-attributes.md) - Prevents duplicate attributes on HTML elements
23
30
  - [`html-no-duplicate-ids`](./html-no-duplicate-ids.md) - Prevents duplicate IDs within a document
24
31
  - [`html-no-nested-links`](./html-no-nested-links.md) - Prevents nested anchor tags
32
+ - [`html-no-positive-tab-index`](./html-no-positive-tab-index.md) - Avoid positive `tabindex` values
33
+ - [`html-no-self-closing`](./html-no-self-closing.md.md) - Disallow self closing tags
34
+ - [`html-no-title-attribute`](./html-no-title-attribute.md) - Avoid using the `title` attribute
25
35
  - [`html-tag-name-lowercase`](./html-tag-name-lowercase.md) - Enforces lowercase tag names in HTML
26
36
  - [`parser-no-errors`](./parser-no-errors.md) - Disallow parser errors in HTML+ERB documents
27
37
  - [`svg-tag-name-capitalization`](./svg-tag-name-capitalization.md) - Enforces proper camelCase capitalization for SVG elements
@@ -0,0 +1,34 @@
1
+ # Linter Rule: Disallow ERB silent tags in HTML attribute names
2
+
3
+ **Rule:** `erb-no-silent-tag-in-attribute-name`
4
+
5
+ ## Description
6
+
7
+ Disallow the use of ERB silent tags (`<% ... %>`) inside HTML attribute names. These tags introduce Ruby logic that does not output anything, and placing them in attribute names leads to malformed HTML or completely unpredictable rendering.
8
+
9
+ ## Rationale
10
+
11
+ HTML attribute names, ideally, must be valid, statically defined strings. Placing ERB silent tags (`<% ... %>`) that don't output anything inside attribute names might result in invalid HTML and is confusing. These cases are rarely intentional and almost always indicate a mistake or misuse of ERB templating.
12
+
13
+ ## Examples
14
+
15
+ ### ✅ Good
16
+
17
+ ```erb
18
+ <div data-<%= key %>-target="value"></div>
19
+ <div <%= data_attributes_for(user) %>></div>
20
+ ```
21
+
22
+ ### 🚫 Bad
23
+
24
+ ```erb
25
+ <div data-<% key %>-id="value"></div>
26
+
27
+ <div data-<%# key %>-id="thing"></div>
28
+
29
+ <div data-<%- key -%>-id="thing"></div>
30
+ ```
31
+
32
+ ## References
33
+
34
+ \-
@@ -0,0 +1,49 @@
1
+ # Linter Rule: `aria-label` must be well-formatted
2
+
3
+ **Rule:** `html-aria-label-is-well-formatted`
4
+
5
+ ## Description
6
+
7
+ Ensure that the value of the `aria-label` attribute is formatted like natural, visual text. The text should use sentence case (capitalize the first letter), avoid line breaks, and not look like an ID or code identifier.
8
+
9
+ ## Rationale
10
+
11
+ The `aria-label` attribute provides an accessible name for elements that will be read aloud by screen readers. The text should be formatted like natural language that users would expect to hear, not like technical identifiers. Using proper sentence case and avoiding formatting that looks like code (snake_case, kebab-case, camelCase) ensures a better user experience for assistive technology users.
12
+
13
+ ## Examples
14
+
15
+ ### ✅ Good
16
+
17
+ ```erb
18
+ <button aria-label="Close dialog">X</button>
19
+ <input aria-label="Search products" type="search">
20
+ <button aria-label="Page 2 of 10">2</button>
21
+ ```
22
+
23
+ ### 🚫 Bad
24
+
25
+ ```erb
26
+ <!-- Starts with lowercase -->
27
+ <button aria-label="close dialog">X</button>
28
+
29
+ <!-- Contains line breaks -->
30
+ <button aria-label="Close
31
+ dialog">X</button>
32
+
33
+ <!-- Looks like an ID (snake_case) -->
34
+ <button aria-label="close_dialog">X</button>
35
+
36
+ <!-- Looks like an ID (kebab-case) -->
37
+ <button aria-label="close-dialog">X</button>
38
+
39
+ <!-- Looks like an ID (camelCase) -->
40
+ <button aria-label="closeDialog">X</button>
41
+
42
+ <!-- HTML entity line breaks -->
43
+ <button aria-label="Close&#10;dialog">X</button>
44
+ ```
45
+
46
+ ## References
47
+
48
+ - [ARIA: `aria-label` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label)
49
+ - [erblint-github: GitHub::Accessibility::AriaLabelIsWellFormatted](https://github.com/github/erblint-github/blob/main/docs/rules/accessibility/aria-label-is-well-formatted.md)
@@ -0,0 +1,35 @@
1
+ # Linter Rule: No whitespace around `=` in HTML attributes
2
+
3
+ **Rule:** `html-attribute-equals-spacing`
4
+
5
+ ## Description
6
+
7
+ Disallow whitespace before or after the equals sign (`=`) for attribute values in HTML. Attributes must follow the canonical format (`name="value"`) with no spaces between the attribute name, the equals sign, or the opening quote.
8
+
9
+ ## Rationale
10
+
11
+ Extra whitespace around the `=` in HTML attribute assignments is unnecessary, inconsistent, and not idiomatic. While browsers are usually forgiving, it can lead to confusing diffs, poor formatting, or inconsistent parsing in tools.
12
+
13
+ ## Examples
14
+
15
+ ### ✅ Good
16
+
17
+ ```erb
18
+ <div class="container"></div>
19
+ <img src="/logo.png" alt="Logo">
20
+ <input type="text" value="<%= @value %>">
21
+ ```
22
+
23
+ ### 🚫 Bad
24
+
25
+ ```erb
26
+ <div class ="container"></div>
27
+
28
+ <img src= "/logo.png" alt="Logo">
29
+
30
+ <input type = "text">
31
+ ```
32
+
33
+ ## References
34
+
35
+ \-
@@ -0,0 +1,48 @@
1
+ # Linter Rule: Avoid using both `disabled` and `aria-disabled` attributes
2
+
3
+ **Rule:** `html-avoid-both-disabled-and-aria-disabled`
4
+
5
+ ## Description
6
+
7
+ Prevent using both the native `disabled` attribute and the `aria-disabled` attribute on the same HTML element. Elements should use either the native `disabled` attribute or `aria-disabled`, but not both.
8
+
9
+ ## Rationale
10
+
11
+ Using both `disabled` and `aria-disabled` on the same element creates redundancy and potential confusion for assistive technologies. The native `disabled` attribute provides both visual and functional disabling, while `aria-disabled` only provides semantic information without preventing interaction. Having both can lead to inconsistent behavior and unclear expectations for users.
12
+
13
+ Elements that support the native `disabled` attribute include: `button`, `fieldset`, `input`, `optgroup`, `option`, `select`, and `textarea`.
14
+
15
+ ## Examples
16
+
17
+ ### ✅ Good
18
+
19
+ ```erb
20
+ <!-- Use only the native disabled attribute -->
21
+ <button disabled>Submit</button>
22
+ <input type="text" disabled>
23
+
24
+ <!-- Use only aria-disabled for custom elements -->
25
+ <div role="button" aria-disabled="true">Custom Button</div>
26
+
27
+ <!-- Use only aria-disabled -->
28
+ <button aria-disabled="true">Submit</button>
29
+ ```
30
+
31
+ ### 🚫 Bad
32
+
33
+ ```erb
34
+ <!-- Both disabled and aria-disabled -->
35
+ <button disabled aria-disabled="true">Submit</button>
36
+
37
+ <input type="text" disabled aria-disabled="true">
38
+
39
+ <select disabled aria-disabled="true">
40
+ <option>Option 1</option>
41
+ </select>
42
+ ```
43
+
44
+ ## References
45
+
46
+ - [HTML: `disabled` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled)
47
+ - [ARIA: `aria-disabled` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-disabled)
48
+ - [erblint-github: GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled](https://github.com/github/erblint-github/blob/main/docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
@@ -0,0 +1,43 @@
1
+ # Linter Rule: `iframe` elements must have a `title` attribute
2
+
3
+ **Rule:** `html-iframe-has-title`
4
+
5
+ ## Description
6
+
7
+ Ensure that all `iframe` elements have a meaningful `title` attribute that describes the content of the frame. The title should not be empty or contain only whitespace.
8
+
9
+ ## Rationale
10
+
11
+ The `title` attribute on `iframe` elements provides essential context for screen reader users about what content the frame contains. Without this information, users of assistive technology cannot understand the purpose or content of the embedded frame, creating significant accessibility barriers.
12
+
13
+ ::: tip Note
14
+ `<iframe>`'s with `aria-hidden="true"` are exempt from this requirement as they are hidden from assistive technologies.
15
+ :::
16
+
17
+ ## Examples
18
+
19
+ ### ✅ Good
20
+
21
+ ```erb
22
+ <iframe src="https://youtube.com/embed/123" title="Product demonstration video"></iframe>
23
+ <iframe src="https://example.com" title="Example website content"></iframe>
24
+
25
+ <!-- Hidden from screen readers -->
26
+ <iframe aria-hidden="true"></iframe>
27
+ ```
28
+
29
+ ### 🚫 Bad
30
+
31
+ ```erb
32
+ <iframe src="https://example.com"></iframe>
33
+
34
+ <iframe src="https://example.com" title=""></iframe>
35
+
36
+ <iframe src="https://example.com" title=" "></iframe>
37
+ ```
38
+
39
+ ## References
40
+
41
+ - [HTML: `iframe` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)
42
+ - [HTML: `title` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title)
43
+ - [erblint-github: GitHub::Accessibility::IframeHasTitle](https://github.com/github/erblint-github/blob/main/docs/rules/accessibility/iframe-has-title.md)
@@ -0,0 +1,61 @@
1
+ # Linter Rule: Navigation landmarks must have accessible labels
2
+
3
+ **Rule:** `html-navigation-has-label`
4
+
5
+ ## Description
6
+
7
+ Ensure that navigation landmarks have a unique accessible name via `aria-label` or `aria-labelledby` attributes. This applies to both `<nav>` elements and elements with `role="navigation"`.
8
+
9
+ ## Rationale
10
+
11
+ Navigation landmarks help users of assistive technology quickly understand and navigate to different sections of a website. When multiple navigation landmarks exist on a page, each needs a unique accessible name so users can distinguish between them (e.g., "Main navigation", "Footer links", "Breadcrumb navigation").
12
+
13
+ ## Examples
14
+
15
+ ### ✅ Good
16
+
17
+ ```erb
18
+ <nav aria-label="Main navigation">
19
+ <ul>
20
+ <li><a href="/">Home</a></li>
21
+ <li><a href="/about">About</a></li>
22
+ </ul>
23
+ </nav>
24
+
25
+ <nav aria-labelledby="breadcrumb-title">
26
+ <h2 id="breadcrumb-title">Breadcrumb</h2>
27
+ <ol>
28
+ <li><a href="/">Home</a></li>
29
+ <li>Current Page</li>
30
+ </ol>
31
+ </nav>
32
+
33
+ <div role="navigation" aria-label="Footer links">
34
+ <a href="/privacy">Privacy</a>
35
+ <a href="/terms">Terms</a>
36
+ </div>
37
+ ```
38
+
39
+ ### 🚫 Bad
40
+
41
+ ```erb
42
+ <nav>
43
+ <ul>
44
+ <li><a href="/">Home</a></li>
45
+ <li><a href="/about">About</a></li>
46
+ </ul>
47
+ </nav>
48
+
49
+ <div role="navigation">
50
+ <a href="/privacy">Privacy</a>
51
+ <a href="/terms">Terms</a>
52
+ </div>
53
+ ```
54
+
55
+ ## References
56
+
57
+ - [ARIA: `navigation` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/navigation_role)
58
+ - [HTML: `nav` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/nav)
59
+ - [ARIA: `aria-label` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label)
60
+ - [ARIA: `aria-labelledby` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-labelledby)
61
+ - [erblint-github: GitHub::Accessibility::NavigationHasLabel](https://github.com/github/erblint-github/blob/main/docs/rules/accessibility/navigation-has-label.md)
@@ -0,0 +1,54 @@
1
+ # Linter Rule: Focusable elements should not have `aria-hidden="true"`
2
+
3
+ **Rule:** `html-no-aria-hidden-on-focusable`
4
+
5
+ ## Description
6
+
7
+ Prevent using `aria-hidden="true"` on elements that can receive keyboard focus. When an element is focusable but hidden from screen readers, it creates a confusing experience where keyboard users can tab to "invisible" elements.
8
+
9
+ ## Rationale
10
+
11
+ Elements with `aria-hidden="true"` are completely hidden from assistive technologies, but they remain visible and interactive for mouse and keyboard users. If a focusable element is hidden from screen readers, keyboard-only users (especially those using screen readers) will encounter focused elements that provide no accessible information, creating a broken user experience.
12
+
13
+ ## Examples
14
+
15
+ ### ✅ Good
16
+
17
+ ```erb
18
+ <button>Submit</button>
19
+ <a href="/link">Link</a>
20
+ <input type="text">
21
+ <textarea></textarea>
22
+
23
+ <div aria-hidden="true">Decorative content</div>
24
+ <span aria-hidden="true">🎉</span>
25
+
26
+ <button tabindex="-1" aria-hidden="true">Hidden button</button>
27
+ ```
28
+
29
+ ### 🚫 Bad
30
+
31
+ ```erb
32
+ <button aria-hidden="true">Submit</button>
33
+
34
+ <a href="/link" aria-hidden="true">Link</a>
35
+
36
+ <input type="text" aria-hidden="true">
37
+
38
+ <textarea aria-hidden="true"></textarea>
39
+
40
+ <select aria-hidden="true">
41
+ <option>Option</option>
42
+ </select>
43
+
44
+ <div tabindex="0" aria-hidden="true">Focusable div</div>
45
+
46
+ <a href="/link" aria-hidden="true">Hidden link</a>
47
+ ```
48
+
49
+ ## References
50
+
51
+ - [ARIA: `aria-hidden` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-hidden)
52
+ - [HTML: `tabindex` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex)
53
+ - [WebAIM: Keyboard Accessibility](https://webaim.org/techniques/keyboard/)
54
+ - [erblint-github: GitHub::Accessibility::NoAriaHiddenOnFocusable](https://github.com/github/erblint-github/blob/main/docs/rules/accessibility/no-aria-hidden-on-focusable.md)