cargo-spellcheck

使用 hunspell 和/或 nlprule 检查拼写。

使用场景

运行 cargo spellcheck --fix 或 cargo spellcheck fix 以修复所有文档注释，避免在源代码树中出现令人讨厌的打字错误。旨在简化审查并提高学习阶段后针对特定主题/领域的自定义语言 CI 检查。

cargo-spellcheck 也是从 git 提交钩子或 CI/CD 系统运行的有价值的工具。

检查拼写和/或语法错误

cargo spellcheck check

error: spellcheck
   --> src/main.rs:44
    |
 44 | Fun facets shalld cause some erroris.
    |            ^^^^^^
    | - shall or shall d
    |

交互式应用建议

cargo spellcheck fix

error: spellcheck(Hunspell)
    --> /media/supersonic1t/projects/cargo-spellcheck/src/literalset.rs:291
     |
 291 |  Returns literl within the Err variant if not adjacent
     |          ^^^^^^

(13/14) Apply this suggestion [y,n,q,a,d,j,e,?]?

   lite
   litter
   litterer
   liter l
   liters
   literal
   liter
 » a custom replacement literal

安装

cargoinstall --lockedcargo-spellcheck

使用 --locked 标志是安装并获取测试依赖集的首选方式。

自动完成

cargo spellcheck completions 通过 $SHELL 自动检测您的当前 shell，

或

cargospellcheck completions --shellzsh

明确指定您的 shell 类型。

通常，您可以在 shell 的 .rc* 文件中使用这种方式

source<(cargo spellcheck completions)

注意：有一个 相关的 clap 问题 (#3508) 导致在某些情况下失败。

🎈 贡献！

非常欢迎贡献！

通常，这样做的方式是在您想要解决的问题的实现/修复的问题中评论。

这通常是通过一个初始 PR 来进行的，然后讨论并迭代地改进实现。不需要一开始就完全正确！

文档

• 功能和路线图
• 常见问题的解决方案
• 配置
• 可用的检查器
• cargo-spellcheck的自动化