docs: add spell checker to ci #743
Open
+241
−200
Conversation
This file contains 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
Adds cspell to CI to catch typos in code and docs.
achingbrain
force-pushed
the
docs/add-spellcheck-to-ci
branch
from
f620b57 to
b9ec6c7
Compare
Closed
2color
reviewed
Feb 24, 2025
| @@ -57,12 +57,12 @@ export interface WantListEntry { | |||
| /** | |||
| * Whether the remote should tell us if they have the block or not | |||
| */ | |||
| sendDontHave: boolean | |||
| sendDoNotHave: boolean | |||
There was a problem hiding this comment.
Since we export this interface, does this qualify as a breaking change?
2color
reviewed
Feb 24, 2025
| @@ -31,14 +31,15 @@ | |||
| "lint": "aegir run lint", | |||
| "dep-check": "aegir run dep-check", | |||
| "doc-check": "aegir run doc-check", | |||
| "spell-check": "aegir spell-check", | |||
There was a problem hiding this comment.
Should we add a check script that runs all 4:
- npm run lint
- npm run dep-check
- npm run doc-check
- npm run spell-check
Specifically, this seems like it would be useful for external contributors, when checks fails to run, they can fix locally quickly, without familiarity with each of the scripts.
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.
Adds cspell to CI to catch typos in code and docs.
Change checklist