-
Notifications
You must be signed in to change notification settings - Fork 1k
Add codespell support with configuration and fixes #822
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
1dc2ca3
0689f56
2c9b695
29232d5
10d3c93
e247fd1
9659bc2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| [codespell] | ||
| # Ref: https://github.com/codespell-project/codespell#using-a-config-file | ||
| skip = .git*,*.svg,package-lock.json,*-lock.yaml,*.lock,*.css,.codespellrc,.cache,.npm | ||
| check-hidden = true | ||
| # Ignore embedded base64 images in notebooks and camelCase/PascalCase identifiers | ||
| ignore-regex = ^\s*"image/\S+": ".*|\b[a-z]+[A-Z]\w*\b|\b[A-Z][a-z]+[A-Z]\w*\b | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The current regex for ignoring PascalCase identifiers (
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not too bad AI! but I would say we can enter those waters when run into them |
||
| ignore-words-list = ser,cyclin | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Codespell configuration is within .codespellrc | ||
| --- | ||
| name: Codespell | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| codespell: | ||
| name: Check for spelling errors | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Codespell | ||
| uses: codespell-project/actions-codespell@v2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a good practice to also exclude common build output and dependency directories from spell checking. Consider adding
node_modules,build, anddistto theskiplist to avoid spell-checking third-party code and generated files.