Linter Rules

This page contains documentation for all Herb Linter rules.

Available Rules

Accessibility

• a11y-avoid-generic-link-text - Avoid generic link text like "Click here" or "Read more"
• a11y-disabled-attribute - Prevent usage of the disabled attribute on unsupported elements
• a11y-nested-interactive-elements - Disallow nesting interactive elements
• a11y-no-accesskey-attribute - Prevent usage of the accesskey attribute
• a11y-no-aria-label-misuse - Prevent aria-label and aria-labelledby on non-interactive elements
• a11y-no-aria-unsupported-elements - Prevent usage of ARIA on unsupported elements
• a11y-no-autofocus-attribute - Prevent usage of the autofocus attribute
• a11y-no-redundant-image-alt - Prevent redundant words in <img> alt attributes
• a11y-no-visually-hidden-interactive-elements - Prevent visually hidden interactive elements
• a11y-svg-has-accessible-text - Require accessible text on <svg> elements

Action View

• actionview-no-content-argument-with-block - Disallow passing a content argument to a helper that is given a block
• actionview-no-dynamic-partial-path - Disallow partial paths that are built at runtime
• actionview-no-helper-shadowing - Disallow shadowing Action View helpers with block variables
• actionview-no-implicit-partial - Disallow render calls that infer the partial from an object
• actionview-no-implicit-polymorphic-url - Prefer explicit route helpers over implicit polymorphic URLs
• actionview-no-mistyped-locals - Disallow literal render arguments that contradict a strict local's declared default type
• actionview-no-redundant-local-assigns - Disallow local_assigns reads that the strict locals declaration already answers
• actionview-no-render-option-shadowing - Disallow locals that shadow a render option name
• actionview-no-silent-helper - Disallow silent ERB tags for Action View helpers
• actionview-no-silent-render - Disallow calling render without outputting the result
• actionview-no-strict-locals-error - Disallow render calls that would raise an ActionView::StrictLocalsError
• actionview-no-unnecessary-html-safe - Disallow calling .html_safe on String literals
• actionview-no-unnecessary-tag-attributes - Disallow unnecessary attributes on Action View tag helpers
• actionview-no-unused-strict-locals - Disallow strict locals that are never used in the partial
• actionview-no-void-element-content - Disallow content arguments for void Action View elements
• actionview-prefer-collection-render - Prefer collection rendering over rendering a partial in a loop
• actionview-prefer-form-with - Prefer the form_with helper over the legacy form_for helper
• actionview-prefer-link-to-helper - Prefer link_to over a manual <a> tag with an ERB href
• actionview-prefer-pluralize-helper - Prefer the pluralize helper over a separate count and String#pluralize
• actionview-prefer-qualified-partial-path - Prefer partial paths qualified from the view root
• actionview-strict-locals-first-line - Require strict locals on the first line of a template with a blank line after.
• actionview-strict-locals-partial-only - Only allow strict local definitions in partial files.

ERB

• erb-closing-tag-indent - Enforce consistent closing ERB tag indentation
• erb-comment-syntax - Disallow Ruby comments immediately after ERB tags
• erb-no-byte-order-mark - Disallow a byte order mark at the start of a template
• erb-no-case-node-children - Don't use children for case/when and case/in nodes
• erb-no-class-definitions - Disallow class definitions in ERB templates
• erb-no-commented-out-output-tags - Disallow commented-out ERB output tags (<%#=, <%# =)
• erb-no-conditional-html-element - Disallow conditional HTML elements
• erb-no-conditional-open-tag - Disallow conditional HTML open tags
• erb-no-debug-output - Disallow debug output methods (p, pp, puts, print, debug) in ERB templates
• erb-no-duplicate-branch-elements - Disallow duplicate elements across conditional branches
• erb-no-empty-control-flow - Disallow empty ERB control flow blocks
• erb-no-empty-tags - Disallow empty ERB tags
• erb-no-extra-newline - Disallow extra newlines.
• erb-no-extra-whitespace-inside-tags - Disallow multiple consecutive spaces inside ERB tags
• erb-no-inline-case-conditions - Disallow inline case/when and case/in conditions in a single ERB tag
• erb-no-instance-variables-in-partials - Disallow instance variables in partials
• erb-no-interpolated-class-names - Disallow ERB interpolation inside CSS class names
• erb-no-javascript-tag-helper - Disallow javascript_tag helper
• erb-no-method-definitions - Disallow method definitions in ERB templates
• erb-no-module-definitions - Disallow module definitions in ERB templates
• erb-no-multiple-statements - Disallow multiple Ruby statements in a single ERB tag
• erb-no-output-control-flow - Prevents outputting control flow blocks
• erb-no-output-in-attribute-name - Disallow ERB output in attribute names
• erb-no-output-in-attribute-position - Disallow ERB output in attribute position
• erb-no-raw-output-in-attribute-value - Disallow <%== in attribute values
• erb-no-return - Disallow return statements in ERB templates
• erb-no-shadowed-block-argument - Disallow block arguments that shadow an enclosing binding
• erb-no-silent-statement - Disallow silent ERB statements
• erb-no-silent-tag-in-attribute-name - Disallow ERB silent tags in HTML attribute names
• erb-no-sleep - Disallow sleep in ERB templates
• erb-no-statement-in-script - Disallow ERB statements inside <script> tags
• erb-no-then-in-control-flow - Disallow then in ERB control flow expressions
• erb-no-trailing-whitespace - Disallow trailing whitespace at end of lines.
• erb-no-unsafe-js-attribute - Disallow unsafe ERB output in JavaScript attributes
• erb-no-unsafe-raw - Disallow raw() and .html_safe in ERB output
• erb-no-unsafe-script-interpolation - Disallow unsafe ERB output inside <script> tags
• erb-no-unused-block-argument - Disallow unused block arguments in ERB blocks
• erb-no-unused-expressions - Disallow unused expressions in silent ERB tags
• erb-no-unused-literals - Disallow Ruby literals in ERB without output
• erb-no-unused-local-variable - Disallow unused local variables in ERB templates
• erb-prefer-direct-output - Prefer direct ERB output over string interpolation
• erb-prefer-do-end-blocks - Prefer do ... end over { ... } for blocks that span multiple ERB tags
• erb-prefer-each-over-map - Prefer each over map when the result is discarded
• erb-prefer-explicit-conditionals - Prefer explicit if/unless blocks over inline conditions in ERB output tags
• erb-prefer-image-tag-helper - Prefer image_tag helper over <img> with ERB expressions
• erb-require-trailing-newline - Enforces that all HTML+ERB template files end with exactly one trailing newline character.
• erb-require-whitespace-inside-tags - Requires whitespace around ERB tags
• erb-right-trim - Enforce consistent right-trimming syntax.
• erb-strict-locals-comment-syntax - Enforce strict locals comment syntax.
• erb-strict-locals-required - Require strict locals in Rails partials.

Herb

• herb-config-framework-option - Require the framework option to be set in .herb.yml.
• herb-disable-comment-malformed - Detect malformed herb:disable comments.
• herb-disable-comment-missing-rules - Require rule names in herb:disable comments.
• herb-disable-comment-no-duplicate-rules - Disallow duplicate rule names in herb:disable comments.
• herb-disable-comment-no-redundant-all - Disallow redundant use of all in herb:disable comments.
• herb-disable-comment-unnecessary - Detect unnecessary herb:disable comments.
• herb-disable-comment-valid-rule-name - Validate rule names in herb:disable comments.
• herb-component-requires-slots - Require a herb:slots directive on templates using component tags.
• herb-into-requires-collection - Require data-herb-into to name a keyed collection.
• herb-scoped-style-no-unused-selector - No unused selector in a <style scoped> block.
• herb-scoped-style-require-top-level - Require a <style scoped> block to be a top-level element.
• herb-scoped-style-single-declaration - One <style scoped> block per file.
• herb-slots-single-directive - Allow one herb:slots directive per template.
• herb-slots-valid-components - Validate component structure and attributes in slots templates.
• herb-slots-valid-mode - Validate the herb:slots mode.
• herb-state-no-silent-reads - Disallow bare state reads in silent tags.
• herb-state-no-server-writes - Disallow server-side writes to declared states.
• herb-state-no-shadowed-states - Disallow block arguments that shadow a declared herb:state name.
• herb-state-no-unused-states - Disallow unused herb:state declarations.
• herb-state-requires-slots - Require a herb:slots directive for herb:state.
• herb-state-directive-syntax - Spell the herb:state directive in its canonical form.
• herb-state-single-declaration - One herb:state declaration per scope.
• herb-state-valid-actions - Validate data-herb-* action attributes.
• herb-state-valid-bindings - Validate the kind a bound form control holds.
• herb-state-valid-declaration - Validate herb:state declarations.
• herb-state-valid-reads - Validate how declared states are read.
• herb-valid-slot-names - Validate data-herb-name slot names.

HTML

• html-allowed-script-type - Restrict allowed type attributes for <script> tags
• html-anchor-require-href - Requires an href attribute on anchor tags
• html-aria-attribute-must-be-valid - Disallow invalid or unknown aria-* attributes.
• html-aria-label-is-well-formatted - aria-label must be well-formatted
• html-aria-level-must-be-valid - aria-level must be between 1 and 6
• html-aria-role-heading-requires-level - Requires aria-level when supplying a role
• html-aria-role-must-be-valid - The role attribute must have a valid WAI-ARIA Role.
• html-attribute-double-quotes - Enforces double quotes for attribute values
• html-attribute-equals-spacing - No whitespace around = in HTML attributes
• html-attribute-name-valid-characters - Requires letters, digits, and hyphens in attribute names
• html-attribute-values-require-quotes - Requires quotes around attribute values
• html-avoid-both-disabled-and-aria-disabled - Avoid using both disabled and aria-disabled attributes
• html-body-only-elements - Require content elements inside <body>.
• html-boolean-attributes-no-value - Prevents values on boolean attributes
• html-details-has-summary - Require <summary> in <details> elements
• html-head-only-elements - Require head-scoped elements inside <head>.
• html-iframe-has-title - iframe elements must have a title attribute
• html-img-require-alt - Requires alt attributes on <img> tags
• html-input-require-autocomplete - Require autocomplete attributes on <input> tags.
• html-navigation-has-label - Navigation landmarks must have accessible labels
• html-no-abstract-roles - No abstract ARIA roles
• html-no-aria-hidden-on-body - No aria-hidden on <body>
• html-no-aria-hidden-on-focusable - Focusable elements should not have aria-hidden="true"
• html-no-block-inside-inline - Prevents block-level elements inside inline elements
• html-no-duplicate-attributes - Prevents duplicate attributes on HTML elements
• html-no-duplicate-ids - Prevents duplicate IDs within a document
• html-no-duplicate-meta-names - Duplicate <meta> name attributes are not allowed.
• html-no-empty-attributes - Attributes must not have empty values
• html-no-empty-css-rule - No empty CSS rule in a <style> block.
• html-no-empty-headings - Disallow empty heading elements
• html-no-event-handler-attributes - Disallow inline event handler attributes
• html-no-inline-script-elements - Disallow inline script elements
• html-no-literal-nbsp - Disallow literal non-breaking spaces, prefer  
• html-no-nested-forms - Prevents nested form elements, including Rails form helpers
• html-no-nested-links - Prevents nested anchor tags
• html-no-obsolete-tags - Disallow obsolete HTML tags
• html-no-positive-tab-index - Avoid positive tabindex values
• html-no-self-closing - Disallow self closing tags
• html-no-space-in-tag - Disallow spaces in HTML tags
• html-no-style-attributes - Disallow inline style attributes
• html-no-style-elements - Disallow inline <style> tags
• html-no-title-attribute - Avoid using the title attribute
• html-no-underscores-in-attribute-names - Disallow underscores in HTML attribute names
• html-no-unescaped-entities - Disallow unescaped HTML entities
• html-no-unknown-tag - Disallow unknown HTML tags
• html-require-closing-tags - Require closing tags for non-void HTML elements
• html-require-script-nonce - Require a nonce attribute on inline scripts
• html-tag-name-lowercase - Enforces lowercase tag names in HTML

Parser

• parser-no-errors - Disallow parser errors in HTML+ERB documents

Source

• source-indentation - Indent with spaces instead of tabs.

SVG

• svg-no-deprecated-tags - Disallow SVG elements removed from SVG 2
• svg-tag-name-capitalization - Enforces proper camelCase capitalization for SVG elements

Turbo

• turbo-permanent-no-misleading-value - Disallow misleading values on data-turbo-permanent
• turbo-permanent-require-id - Require id attribute on elements with data-turbo-permanent

UJS

• ujs-no-remote-attribute - Disallow the deprecated data-remote attribute and helper option
• ujs-prefer-turbo-confirm - Prefer data-turbo-confirm over the deprecated data-confirm
• ujs-prefer-turbo-method - Prefer data-turbo-method over the deprecated data-method
• ujs-prefer-turbo-submits-with - Prefer data-turbo-submits-with over the deprecated data-disable-with

Contributing

To add a new linter rule:

1. Create the rule class implementing the Rule interface
2. Add comprehensive tests in test/rules/
3. Add documentation in docs/rules/
4. Update the main linter to include the rule by default (if appropriate)

See html-tag-name-lowercase.ts for an example implementation.