ci: Add spell checker #158
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #158 +/- ##
=======================================
Coverage 100.0% 100.0%
=======================================
Files 90 90
Lines 6497 6497
=======================================
Hits 6497 6497 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
geeknoid
force-pushed
the
docs
branch
4 times, most recently
from
6bc709b to
db19335
Compare
geeknoid
force-pushed
the
docs
branch
9 times, most recently
from
b6d20fb to
792751f
Compare
geeknoid
force-pushed
the
docs
branch
14 times, most recently
from
6b39e3d to
06a2d4b
Compare
geeknoid
force-pushed
the
docs
branch
5 times, most recently
from
89f1497 to
58b5a25
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a spell checker to the CI pipeline using cargo-spellcheck to catch spelling errors in documentation, comments, and code. The changes include configuring the spell checker, adding a custom dictionary with 286 words, and correcting numerous spelling/grammar issues across the codebase.
- Adds CI workflow for spell checking with dictionary validation
- Corrects documentation formatting (em-dashes to colons, backtick improvements for Rust references)
- Fixes various spelling errors including "withing" → "within", "ues" → "use", "unware" → "unaware", "Transferrable" → "Transferable"
Reviewed changes
Copilot reviewed 47 out of 49 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| spellcheck.toml | Configuration file for cargo-spellcheck tool with Hunspell settings |
| .spelling | Custom dictionary with 286 technical terms and project-specific words |
| .github/workflows/main.yml | New spell-check job with dictionary validation and spell checking |
| .github/workflows/repo-constants.yml | Adds CARGO_SPELLCHECK_VERSION constant support |
| .github/license-check/config.json | Excludes .dic files from license checking |
| constants.toml | Defines cargo-spellcheck version (0.15.1) |
| Cargo.toml | Changes resolver from version 3 to version 2 |
| crates/tick/* | Improves documentation with better Rust reference formatting and fixes spelling |
| crates/thread_aware/* | Fixes spelling in docs and renames types in examples (Transferrable → Transferable) |
| crates/ohno/* | Improves Rust reference links and fixes spelling (clonable → cloneable) |
| crates/fundle/* | Changes "codebases" to "code bases" in documentation |
| crates/data_privacy/* | Fixes spelling and improves formatting (italic containers, ASCII → identifiers) |
| crates/bytesbuf/* | Corrects typos in comments and documentation |
| crates/ohno_macros/* | Improves code formatting in comments |
| crates/fundle_macros_impl/* | Removes large snapshot file (test regeneration expected) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
geeknoid
force-pushed
the
docs
branch
2 times, most recently
from
8014022 to
2d02797
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 49 out of 49 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
geeknoid
force-pushed
the
docs
branch
2 times, most recently
from
90fe4ad to
d6a25c7
Compare
psandana
left a comment
psandana
left a comment
There was a problem hiding this comment.
Left some suggestions that can be fixed in a subsequent PR
geeknoid
dismissed
sandersaares’s stale review
Requested changes done, unblocking PR.
No description provided.