Lint feature descriptions with Vale #3045
Open
Conversation
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
github-actions
bot
added
documentation
ddbeck
force-pushed
the
vale-lint
branch
8 times, most recently
from
d75df18 to
5059a5d
Compare
ddbeck
commented
Jun 11, 2025
| @@ -1,5 +1,5 @@ | |||
| name: "@charset" | |||
| description: The `@charset` CSS at-rule specifies the character encoding of an external style sheet. | |||
| description: The `@charset` CSS at-rule specifies the character encoding of an external style sheet. | |||
There was a problem hiding this comment.
I changed this file so it would get flagged on review. Before merging, I ought to undo this change, to show I'm just ignoring this suggestion.
| @@ -1,5 +1,5 @@ | |||
| name: <del> | |||
| description: The `<del>` element element represents a range of text that has been deleted from a document, styling text as strikethrough by default. | |||
| description: The `<del>` element element represents a range of text that has been deleted from a document, styling text as strikethrough by default. | |||
There was a problem hiding this comment.
I changed this file so it would get flagged on review. Before merging, I ought to push a change fixing it.
| @@ -1,5 +1,5 @@ | |||
| name: beforeunload | |||
| description: "The `beforeunload` event is fired when the current window is about to be unloaded. Typically this is used to display a dialog to confirm if users really want to leave the page when there is unsaved data that would be lost." | |||
| description: "The `beforeunload` event is fired when the current window is about to be unloaded. Typically you use this to display a dialog to confirm if users really want to leave the page when there is unsaved data that would be lost." | |||
There was a problem hiding this comment.
This (and several other feature changes) fix warnings or errors from Vale.
ddbeck
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR imposes some automatic checks on feature descriptions using Vale.
I've turned on some default rules from Vale (like detecting words
doubleddoubled up) and a couple of rules from our guidelines. There are many other rules we could turn on (such as spelling) if we like this approach.See my self review (and generated comments) to see how this would work in practice.