ci: Replace woke with codespell #127
Open
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
spetrosi
force-pushed
the
codespell-init
branch
from
af6c749 to
03965e7
Compare
woke has been left with Noriko's and all other PRs not being reviewed for years, hence we have been using our fork. get-woke/woke#252 woke has a limitation that doesn't allow ignoring lines of code, codespell allows for this. Replacing woke with codespell that provides a dictionary for replacing phrasing with recommended terms: https://github.com/codespell-project/codespell/blob/main/codespell_lib/data/dictionary_usage.txt It also supports using custom dictionaries so we can add to the list if we want For more information about inclusive naming initiative, see https://inclusivenaming.org/about/ Codespell also checks spelling, which is an advantage for system roles because a big part of our code is user-facing - task names, debug messages, readmes. `ignore-multiline-regex` in the `.codespellrc` config allows for disabling codespell for a block of lines: ``` # codespell:ignore-begin ... codespell will not look at this text. # codespell:ignore-end ``` Signed-off-by: Sergei Petrosian <[email protected]>
spetrosi
force-pushed
the
codespell-init
branch
from
03965e7 to
f37ee40
Compare
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.
woke has been left with Noriko's and all other PRs not being reviewed for years,
hence we have been using our fork.
get-woke/woke#252
woke has a limitation that doesn't allow ignoring lines of code, codespell
allows for this.
Replacing woke with codespell that provides a dictionary for replacing phrasing
with recommended terms:
https://github.com/codespell-project/codespell/blob/main/codespell_lib/data/dictionary_usage.txt
It also supports using custom dictionaries so we can add to the list if we want
For more information about inclusive naming initiative, see
https://inclusivenaming.org/about/
Codespell also checks spelling, which is an advantage for system roles because a
big part of our code is user-facing - task names, debug messages, readmes.
ignore-multiline-regexin the.codespellrcconfig allows for disablingcodespell for a block of lines: