-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: spellchecking with typos-cli (#990)
* feat: spellchecking with typos-cli - fix all current typos using [typos-cli](https://github.com/crate-ci/typos) - add a _typos.toml - add a github action to check pull requests for spelling errors using [typos](https://github.com/crate-ci/typos) * ci: run spell checking on main --------- Co-authored-by: Liam Dyer <[email protected]>
- Loading branch information
1 parent
4ba1fa1
commit 64cb887
Showing
6 changed files
with
45 additions
and
3 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: Spelling | ||
|
||
permissions: | ||
contents: read | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
|
||
env: | ||
CLICOLOR: 1 | ||
|
||
jobs: | ||
spelling: | ||
name: Spell Check with Typos | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
persist-credentials: false | ||
|
||
- name: Spell Check Repo | ||
uses: crate-ci/typos@685eb3d55be2f85191e8c84acb9f44d7756f84ab # v1.29.4 |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
[files] | ||
extend-exclude = [] | ||
|
||
[default.extend-words] | ||
noice = "noice" | ||
|
||
[default] | ||
extend-ignore-re = [ | ||
# git commit hashes in CHANGELOG.md | ||
"\\[[0-9a-f]{7}\\]", | ||
# Line ignore with trailing # spellchecker:disable-line | ||
"(?Rm)^.*(#|--|//)\\s*spellchecker:disable-line$", | ||
# Line block with # spellchecker:<on|off> | ||
"(?s)(#|--|//|)\\s*spellchecker:off.*?\\n\\s*(#|--|//)\\s*spellchecker:on", | ||
] |
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
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
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