chore: remove workaround for HTML tags#6721
Conversation
1c13f43 to
c6d5d78
Compare
WalkthroughThe PR updates spellcheck configuration and dictionary entries, refactors a linting script, and refreshes documentation link labels and email formatting across multiple files for consistency. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
c6d5d78 to
a9a42f5
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
mise-tasks/lint/spellcheck-markdown.sh (1)
6-12: Consider using an array to preserve filenames safely.While the current codebase has no markdown files with whitespace or special characters that would break the script, the unquoted
$FILESexpansion on line 12 is fragile. Using a bash array with null-terminated find output would make the script more resilient to future changes.🛠️ Suggested improvement
-FILES=$(find . -name "*.md" \ - -not -path "*/node_modules/*" \ - -not -path "*/target/*" \ - -not -path "*/.git/*" \ - -not -path "*/CHANGELOG.md") +mapfile -d '' FILES < <(find . -name "*.md" \ + -not -path "*/node_modules/*" \ + -not -path "*/target/*" \ + -not -path "*/.git/*" \ + -not -path "*/CHANGELOG.md" \ + -print0) -cargo spellcheck check --code 1 $FILES \ +cargo spellcheck check --code 1 "${FILES[@]}" \ || (echo "See .config/spellcheck.md for tips"; false)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@mise-tasks/lint/spellcheck-markdown.sh` around lines 6 - 12, The FILES expansion is fragile because unquoted $FILES breaks on filenames with spaces/special chars; change the find + variable usage to build a null-terminated array (use find ... -print0 piped into readarray/mapfile -d '' to populate FILES as an array) and then call cargo spellcheck with the array quoted as "${FILES[@]}" so filenames are preserved; update the FILES assignment (the find invocation) and the final cargo spellcheck call accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/users/introduction.md`:
- Line 55: The support label contains a typo: change the phrase "Hand-on
Support" to "Hands-on Support" in the user-facing docs line that currently reads
`Partnerships or Hand-on Support: \`forest (at) chainsafe [dot] io\``; update
that exact string to `Partnerships or Hands-on Support: \`forest (at) chainsafe
[dot] io\`` so the document uses the correct "Hands-on Support" wording.
---
Nitpick comments:
In `@mise-tasks/lint/spellcheck-markdown.sh`:
- Around line 6-12: The FILES expansion is fragile because unquoted $FILES
breaks on filenames with spaces/special chars; change the find + variable usage
to build a null-terminated array (use find ... -print0 piped into
readarray/mapfile -d '' to populate FILES as an array) and then call cargo
spellcheck with the array quoted as "${FILES[@]}" so filenames are preserved;
update the FILES assignment (the find invocation) and the final cargo spellcheck
call accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 8d1d3ff4-e172-4e7b-9d7a-485f16b33f04
📒 Files selected for processing (7)
.config/forest.dic.config/spellcheck.tomlCONTRIBUTING.mdREADME.mddocs/docs/users/filecoin_services.mddocs/docs/users/introduction.mdmise-tasks/lint/spellcheck-markdown.sh
Summary of changes
Changes introduced in this pull request:
cargo-spellchecksilently skips files with leading HTML blocks drahnr/cargo-spellcheck#357 is resolved so we can get rid of the workaround already 🚀Reference issue to close (if applicable)
Closes
Other information and links
Change checklist
Outside contributions
Summary by CodeRabbit
Documentation
Chores