CI: Add automated spellchecking #47
Merged
+84
−3
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
#### Problem There are often typos in code or READMEs, but they don't get caught. #### Summary of changes Integrate `cargo spellcheck` to automate spellchecking all Rust code in the repo. I wasn't sure where to put the additional configuration, so I hope `scripts` was an ok destination.
lorisleiva
previously approved these changes
Nov 22, 2024
.github/workflows/main.yml
Outdated
Comment on lines
71
to
79
| - name: Install cargo-spellcheck | ||
| uses: taiki-e/install-action@v2 | ||
| with: | ||
| tool: cargo-spellcheck | ||
|
|
||
| - name: Setup Environment | ||
| uses: ./.github/actions/setup | ||
| with: | ||
| cargo-cache-key: cargo-spellcheck |
Member
There was a problem hiding this comment.
nit: as a convention, the other jobs are using the setup action immediately after the git checkout step. Could we do the same here?
Contributor
Author
There was a problem hiding this comment.
Ah yes, good call, I misunderstood how the cache action works, thanks!
package.json
Outdated
| "clients:rust:test": "zx ./scripts/client/test-rust.mjs", | ||
| "template:upgrade": "zx ./scripts/upgrade-template.mjs" | ||
| "template:upgrade": "zx ./scripts/upgrade-template.mjs", | ||
| "spellcheck:rust": "cargo spellcheck --code 1" |
Member
There was a problem hiding this comment.
Should we call this rust:spellcheck in preparation for febo's work on unifying scripts?
@febo After your refactoring, I think this should be part of the lint subtasks, so it would probably need to be located in scripts/rust/lint-spellcheck. Lmk what you think.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem
There are often typos in code or READMEs, but they don't get caught.
Summary of changes
Integrate
cargo spellcheckto automate spellchecking all Rust code in the repo.I wasn't sure where to put the additional configuration, so I hope
scriptswas an ok destination.