cargo spellcheck

貨物スペルチェック

hunspellおよび/またはnlpruleでスペルを確認してください。

ユースケース

cargo spellcheck --fixまたはcargo spellcheck fixソースツリー全体で厄介なタイプミスを避けるために、すべてのドキュメントコメントを修正します。レビューを簡素化し、カスタム/トピック固有の言語の学習段階の後にCIチェックを改善することを意味しました。

cargo-spellcheck Git Commitフックまたは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

シェルタイプを明示的に指定します。

通常、シェルの.rc*ファイルからこのように使用されます：

source <(cargo spellcheck completions)

注：関連するCLAPの問題（＃3508）があり、場合によってはこれを失敗させます。

？貢献する！

貢献は大歓迎です！

一般的に、そうすることの好ましい方法は、実装/修正に取り組むことを希望する問題でコメントすることです。

これには通常、実装が議論され、繰り返し洗練されている最初のPRが続きます。初めて正しいことをすべて正しくする必要はありません！

ドキュメント

• 機能とロードマップ
• 一般的な問題に対する救済策
• 構成
• 利用可能なチェッカー
• cargo-spellcheckの自動化