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自動化