cargo spellcheck

cargo-spellcheck

Vérifiez votre orthographe avec hunspell et / ou nlprule .

Cas d'utilisation

Exécutez cargo spellcheck --fix ou cargo spellcheck fix pour réparer tous vos commentaires de documentation afin d'éviter les fautes de frappe désagréables partout dans votre arbre source. Signifiait comme une assistance simplifiant l'examen ainsi que l'amélioration des contrôles CI après une phase d'apprentissage pour le jargon personnalisé / sujet.

cargo-spellcheck est également un outil précieux pour fonctionner à partir de crochets Git Commit ou de systèmes CI / CD.

Vérifiez les erreurs d'orthographe et / ou de grammaire

cargo spellcheck check

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

Appliquer des suggestions de manière interactive

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 

Installation

cargo install --locked cargo-spellcheck

L'indicateur --locked est le moyen d'installation préféré pour obtenir l'ensemble de dépendances testé.

Sur OS X, vous devez vous assurer que libclang.dylib peut être trouvé par l'éditeur de liens

qui peut être réalisé en définissant DYLB_FALLBACK_LIBRARY_PATH :

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

Dans Linux, le fichier est libclang.so qui peut être installé via:

 apt-get install libclang-dev

Ensuite, vous pouvez définir la variable LIBCLANG_PATH via:

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

Achèvement

cargo spellcheck completions pour l'autodétection de votre coquille actuelle via $SHELL ,

ou

cargo spellcheck completions --shell zsh

Pour spécifier explicitement votre type de shell.

Généralement, il est utilisé comme celui-ci à partir du fichier .rc* de votre shell:

source <(cargo spellcheck completions)

Remarque: il existe un problème de CLAP pertinent (# 3508) qui fait que cela échoue dans certains cas.

? Contribuer!

Les contributions sont les bienvenues!

Généralement, la façon préférée de le faire est de commenter dans un problème que vous souhaitez aborder l'implémentation / correction.

Ceci est généralement suivi d'un PR initial où la mise en œuvre est ensuite discutée et raffinée de manière itérative. Pas besoin de tout faire correctement la première fois!

Documentation

• Caractéristiques et feuille de route
• Remèdes pour les problèmes communs
• Configuration
• Dynamiques disponibles
• Automatisation de cargo-spellcheck