Improve the no-default-alt-text rule #40
Merged
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.
Contains a few improvements to rough edges around the
no-default-alt-text
rule that I noticed while working on my Markdown checker browser extension:Image
." This shorter description is consistent with the default Markdownlint rulesdetail
field from failures, since it was just a copy of the image's alt text. This was distracting and not very helpful - the detail field is only really useful for showing hints on how to resolve the issue. For example, a useful detail forMD001
looks like: "Expected: h2; Actual: h3"range
field that only covers the alt text so we don't have to error the entire line. This helps draw attention to the specific issue at hand and helps writers figure out specifically where to put better alt text. This required using regular expressions for all checking (instead of only for HTML), because the default Markdown parser tokens don't have ranges