cargo spellcheck

货运式

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

用例

运行cargo spellcheck --fix或cargo spellcheck fix以修复所有文档评论，以避免在源树上避免使用讨厌的错字。意味着作为助手简化审查，并在学习阶段的特定于自定义/主题的学习阶段之后改善了CI检查。

cargo-spellcheck也是从Git Commit Hooks或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 

安装

cargo install --locked cargo-spellcheck

--locked标志是获得测试依赖项集的首选方法。

在OS X上，您需要确保libclang.dylib可以由链接器找到

可以通过设置DYLB_FALLBACK_LIBRARY_PATH来实现这一点：

 export DYLD_FALLBACK_LIBRARY_PATH= 
    "$(xcode-select --print-path)/Toolchains/XcodeDefault.xctoolchain/usr/lib/"

在Linux中，该文件是可以通过以下方式安装的libclang.so 。

 apt-get install libclang-dev

之后，您可以通过以下方式设置可变LIBCLANG_PATH

 export LIBCLANG_PATH=/usr/lib/llvm-14/lib/

完成

通过$SHELL自动调整当前外壳的cargo spellcheck completions

或者

cargo spellcheck completions --shell zsh

明确指定您的外壳类型。

通常是从您的shell的.rc*文件中使用的。

source <(cargo spellcheck completions)

注意：有一个相关的拍手问题（＃3508），在某些情况下使此问题失败。

？贡献！

贡献非常欢迎！

通常，这样做的首选方法是在您想解决实施/修复的问题中发表评论。

通常是初始PR，然后讨论实现并进行迭代完善。无需第一次使一切正确！

文档

• 功能和路线图
• 常见问题的补救措施
• 配置
• 可用的跳棋
• cargo-spellcheck自动化