cargo spellcheck Download - cargo spellcheck Quellcode Download

cargo spellcheck

Anderer Quellcode

v0.14.0

Herunterladen

Fracht-Spellcheck

Überprüfen Sie Ihre Rechtschreibung mit hunspell und/oder nlprule .

Anwendungsfälle

Führen Sie cargo spellcheck --fix oder cargo spellcheck fix um alle Ihre Dokumentationskommentare zu beheben, um böse Tippfehler über Ihren Quellbaum zu vermeiden. Gemeint als Helfer -Vereinfachung und Verbesserung der CI -Überprüfungen nach einer Lernphase für benutzerdefinierte/themenspezifische Lingo.

cargo-spellcheck ist auch ein wertvolles Werkzeug, um von GIT-Commit-Haken oder CI/CD-Systemen zu leiten.

Überprüfen Sie die Rechtschreib- und/oder Grammatikfehler

cargo spellcheck check

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

Vorschläge interaktiv anwenden

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

Das --locked Flag ist die bevorzugte Installationsmethode, um den getesteten Abhängigkeitssatz zu erhalten.

Auf OS X müssen Sie sicherstellen, dass libclang.dylib vom Linker gefunden werden kann

Dies kann erreicht werden, indem DYLB_FALLBACK_LIBRARY_PATH festgelegt wird:

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

In Linux ist die Datei libclang.so , die durch:

 apt-get install libclang-dev

Anschließend können Sie die variable LIBCLANG_PATH über:

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

Fertigstellungen

cargo spellcheck completions für die Autodetektion Ihrer aktuellen Shell über $SHELL ,

oder

cargo spellcheck completions --shell zsh

So geben Sie Ihren Shell -Typ explizit an.

Normalerweise wird es so aus .rc* -Datei Ihrer Shell verwendet:

source <(cargo spellcheck completions)

HINWEIS: Es gibt ein relevantes Clap -Problem (#3508), das dies in einigen Fällen fehlschlägt.

? Beitragen!

Beiträge sind sehr willkommen!

Im Allgemeinen besteht die bevorzugte Art und Weise, dies zu tun, in einem Problem zu kommentieren, das Sie mit der Implementierung/dem Fix befassen möchten.

Dies folgt normalerweise eine anfängliche PR, bei der die Implementierung dann diskutiert und iterativ verfeinert wird. Sie müssen beim ersten Mal nicht alles richtig machen!