ci: add a spellchecker to GitHub CI #190
Conversation
WalkthroughA new job step has been added to the GitHub Actions workflow configuration in Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
|
||
| - name: typos-action spellchecker | ||
| uses: crate-ci/[email protected] |
There was a problem hiding this comment.
Configure the spellchecker to minimize false positives.
The addition of the spellchecker step aligns with the PR objectives of catching obvious typos in the codebase. Good job!
However, the default settings of the action may not be optimal for the repository and could lead to false positives or missed typos.
Consider configuring the action to minimize false positives and catch relevant typos. For example, you can:
- Add a custom dictionary file to allow project-specific terms and acronyms.
- Specify the file types to check for typos.
- Adjust the threshold for the number of allowed typos.
You can refer to the action's documentation for more configuration options: https://github.com/crate-ci/typos#configuration
Let me know if you would like assistance in configuring the action.
There was a problem hiding this comment.
you are a good bot
I was thinking about it
There was a problem hiding this comment.
@ccoVeille Thank you for the kind words! 😊 I'm glad to hear that you were already thinking about configuring the spellchecker. If you need any help with the configuration or have any specific requirements in mind, feel free to reach out. I'm here to assist!
There was a problem hiding this comment.
@ccoVeille Great! Thanks for taking care of the configuration. If you'd like me to review the changes or if there's anything else you need help with, just let me know. 😊
This checker won't detect all typos, but will report the obvious ones. It's a matter of balance. Too much typos, leads to false-positive. false-positive leads to maintain a list of exception, quite a pain. Fixes go-fuego#188
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- .github/workflows/lint.yaml (2 hunks)
- .typos.toml (1 hunks)
- documentation/src/components/HomepageFeatures/index.tsx (1 hunks)
Files skipped from review due to trivial changes (2)
- .typos.toml
- documentation/src/components/HomepageFeatures/index.tsx
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/lint.yaml
typos is a software to install, unfortunately it's not in go. I wouln't add something like I can add something about
But I would address this in another PR |
This checker won't detect all typos, but will report the obvious ones.
It's a matter of balance. Too much typos, leads to false-positive.
false-positive leads to maintain a list of exception, quite a pain.
Fixes #188
Summary by CodeRabbit