Linter: Implement a11y-avoid-generic-link-text rule#1673
Open
joelhawksley wants to merge 2 commits into
Open
Conversation
github-actions
Bot
added
documentation
Implements the `a11y-avoid-generic-link-text` rule from erblint-github's `AvoidGenericLinkText`. This rule flags `<a>` elements with generic link text such as "Read more", "Learn more", "Click here", "More", "Link", or "Here" which do not make sense when read out of context. Screen reader users often navigate by links, so descriptive link text is important for accessibility. Links with `aria-label` or `aria-labelledby` attributes are not flagged, as those provide an accessible name. Links with dynamic ERB content are also skipped since the text cannot be statically analyzed. The rule is disabled by default with a severity of `warning`. Closes marcoroth#1218
marcoroth
changed the title
a11y-avoid-generic-link-text linter rulea11y-avoid-generic-link-text rule
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements the
a11y-avoid-generic-link-textrule from erblint-github'sAvoidGenericLinkText.This rule flags
<a>elements with generic link text such as "Read more", "Learn more", "Click here", "More", "Link", or "Here" which do not make sense when read out of context. Screen reader users often navigate by links, so descriptive link text is important for accessibility.Links with
aria-labeloraria-labelledbyattributes are not flagged, as those provide an accessible name. Links with dynamic ERB content are also skipped since the text cannot be statically analyzed.The rule is disabled by default with a severity of
warning.Closes #1218