Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: ignore code blocks #30

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

fix: ignore code blocks #30

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
075471c
fix: ignore code blocks
bencromwell Nov 14, 2024
a54de17
fix: no code block linting
bencromwell Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,3 @@ write-good.Passive = NO

[formats]
mdx = md

[*.md]
# These rules exist to allow JSX /HTML in markdown files.
BlockIgnores = (?s) *(<[^>]*>)
BlockIgnores = (?s) *(import.*?\n)
BlockIgnores = (?s) *(export.*?\))
Comment on lines -23 to -27
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what to do here to achieve the objective of the comment whilst letting it correctly not parse code blocks and such.

Copy link
Contributor

@ikadix ikadix Nov 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely sure what you mean by this comment ? More specifically I don't immediately see how your added rules prevent these from working ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To sum up - with these BlockIgnores in, for whatever reason it prevents Vale from correctly ignoring code blocks like it would by default for markdown or mdx treated as markdown.

But removing them makes it lint JSX, for example:

<ThemedImage
  alt="Web Form for choosing a package."
  sources={{
    light: "/img/compute_how_to_upgrade_downgrade_package_light.png",
    dark: "/img/compute_how_to_upgrade_downgrade_package_dark.png",
  }}
/>

With this tag, it would pick up "png should be PNG", so it's incorrectly linting the tag.

The solution, imperfect as it is, appears to be to have a project with a tag such as that use its own BlockIgnore:

# Custom tags for JSX/MDX. New lines are supported, see https://vale.sh/docs/topics/config/#blockignores 
BlockIgnores = (?s) *<ThemedImage\b[^>]*>(.*?)<\/ThemedImage>|<ThemedImage\b[^>]*\/>

for each tag it wants to do (a little painful).