chore: add spellchecker #65
Conversation
WalkthroughThis pull request introduces multiple changes across various files. Key updates include the addition of new entries in the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GitHub
participant Codespell
participant PR_Creator
User->>GitHub: Create Pull Request
GitHub->>Codespell: Trigger Spell Check
Codespell->>Codespell: Check for spelling errors
Codespell->>PR_Creator: Create Pull Request with fixes
PR_Creator->>User: Notify about spell check results
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 golangci-lintlevel=warning msg="The linter 'exportloopref' is deprecated (since v1.60.2) due to: Since Go1.22 (loopvar) this linter is no longer relevant. Replaced by copyloopvar." 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}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (3)
.github/workflows/spellcheck.yml (3)
3-5: Consider adding more trigger eventsThe workflow currently only runs on pull requests. Consider adding triggers for pushes to the main branch to catch typos that might slip through PR reviews.
on: pull_request: + push: + branches: + - main
16-16: Improve maintainability of skip patternsThe skip pattern is complex and hard to maintain. Consider moving it to a configuration file.
Create a new file
.github/config/codespell-skip.txt:*.pulsar.go *.pb.go *.pb.gw.go *.cosmos_orm.go *.json *.git *.js crypto/keys fuzz *.h proto/tendermint *.bin go.sum go.work.sum go.mod statik.go *.map swagger.yamlThen update the command:
- codespell -w --skip="*.pulsar.go,*.pb.go,*.pb.gw.go,*.cosmos_orm.go,*.json,*.git,*.js,crypto/keys,fuzz,*.h,proto/tendermint,*.bin,go.sum,go.work.sum,go.mod,statik.go,*.map,swagger.yaml" --ignore-words=.github/config/.codespellignore + codespell -w --skip-files-from=.github/config/codespell-skip.txt --ignore-words=.github/config/.codespellignore
25-28: Enhance pull request body with more contextThe current PR body could be more informative. Consider adding:
- List of files that were modified
- Link to the codespell documentation
- Instructions for reviewing the changes
body: | - This PR fixes typos in the codebase. - Please review it, and merge if everything is fine. - If there are proto changes, run `make proto-gen` and commit the changes. + ## Automated Spell Check Results + + This PR contains automated fixes for spelling issues detected by [codespell](https://github.com/codespell-project/codespell). + + ### Review Instructions + 1. Please verify that the changes are legitimate spelling corrections + 2. Ensure no code functionality was accidentally altered + 3. If there are proto changes, run `make proto-gen` and commit the changes + + ### Modified Files + <details> + <summary>Click to expand</summary> + + ``` + ${CHANGED_FILES} + ``` + </details>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (7)
.github/config/.codespellignore(1 hunks).github/workflows/spellcheck.yml(1 hunks)submodules/evm-nft/collect.go(1 hunks)submodules/move-nft/collect.go(1 hunks)submodules/pair/types/types.go(1 hunks)submodules/wasm-pair/types/types.go(1 hunks)x/kvindexer/keeper/keeper.go(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- .github/config/.codespellignore
- submodules/evm-nft/collect.go
- x/kvindexer/keeper/keeper.go
🧰 Additional context used
🪛 golangci-lint
submodules/pair/types/types.go
32-32: File is not goimports-ed
(goimports)
submodules/wasm-pair/types/types.go
32-32: File is not goimports-ed
(goimports)
🔇 Additional comments (2)
.github/workflows/spellcheck.yml (1)
16-16: Verify .codespellignore file existence and location
The workflow references .github/config/.codespellignore. Let's ensure this file exists in the correct location.
✅ Verification successful
Codespell configuration is properly set up
The .codespellignore file exists at the expected location .github/config/.codespellignore and contains a valid list of words to be ignored during spell checking. The workflow configuration is correctly referencing this file.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify .codespellignore file exists and check its contents
# Check if the file exists
if [ -f ".github/config/.codespellignore" ]; then
echo "File exists. Contents:"
cat ".github/config/.codespellignore"
else
echo "Warning: .codespellignore file not found at .github/config/.codespellignore"
# Check if it exists in other common locations
find . -name ".codespellignore" -type f
fi
Length of output: 216
submodules/move-nft/collect.go (1)
164-164: LGTM: Log message typo fix
The correction of "address" spelling in the log message improves clarity while maintaining the same informative context.
Summary by CodeRabbit
Release Notes
New Features
Bug Fixes
AdddresstoAddressin multiple structures to ensure accuracy.Documentation