-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add typo check ci action to automatically detect typo error
Signed-off-by: chaosi-zju <[email protected]>
- Loading branch information
1 parent
8f5b8e7
commit 8d1b9d5
Showing
4 changed files
with
44 additions
and
0 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,15 @@ | ||
name: Typos Check | ||
on: | ||
push: | ||
pull_request: | ||
jobs: | ||
typos-check: | ||
name: Spell Check with Typos | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- name: Checkout Actions Repository | ||
uses: actions/checkout@v4 | ||
- name: Check spelling with custom config file | ||
uses: crate-ci/typos@master | ||
with: | ||
config: ./typos.toml |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# This is the custom config file used by `typos` command and `crate-ci/typos@master` action to do source code spelling correction. | ||
# Sometimes, what looks like a typo is intentional, like with people's names, acronyms, or localized content. | ||
# To mark a word or an identifier (grouping of words) as valid, add it to this file by declaring itself as the valid spelling. | ||
# See https://github.com/crate-ci/typos/blob/master/docs/reference.md for more info to configure typos. | ||
[files] | ||
extend-exclude = [ | ||
"*.svg", | ||
"*.drawio", | ||
] | ||
[default.extend-words] | ||
BA = "BA" | ||
Ded = "Ded" | ||
EDE = "EDE" |