cargo spellcheck

cheque de carga

Revise su ortografía con hunspell y/o nlprule .

Casos de uso

Ejecute el corrector cargo spellcheck --fix cargo spellcheck fix para arreglar todos sus comentarios de documentación para evitar errores tipográficos desagradables en todo su árbol de origen. Significado como un ayudante que simplifica la revisión, así como la mejora de las verificaciones de CI después de una fase de aprendizaje para una jerga específica de temas.

cargo-spellcheck también es una herramienta valiosa para ejecutar desde gits Git Hooks o sistemas CI/CD.

Verifique los errores de ortografía y/o gramática

cargo spellcheck check

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

Aplicar sugerencias de manera interactiva

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 

Instalación

cargo install --locked cargo-spellcheck

La bandera --locked es la forma preferida de instalar para obtener el conjunto probado de dependencias.

En OS X, debe asegurarse de que libclang.dylib se pueda encontrar por el enlazador.

que se puede lograr configurando DYLB_FALLBACK_LIBRARY_PATH :

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

En Linux, el archivo es libclang.so que se puede instalar a través de:

 apt-get install libclang-dev

Posteriormente, puede establecer la variable LIBCLANG_PATH a través de:

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

Finalización

cargo spellcheck completions para la autodetección de su shell actual a través de $SHELL ,

o

cargo spellcheck completions --shell zsh

Para especificar explícitamente su tipo de shell.

Comúnmente se usa así desde el archivo .rc* de su shell:

source <(cargo spellcheck completions)

Nota: Hay un problema de aplausos relevante (#3508) que hace que esto falle en algunos casos.

? ¡Contribuir!

¡Las contribuciones son muy bienvenidas!

En general, la forma preferida de hacerlo es comentar en un tema que le gustaría abordar la implementación/solución.

Esto generalmente es seguido por un PR inicial donde la implementación se discute y se refina iterativamente. ¡No es necesario que todo corrija la primera vez!

Documentación

• Características y hoja de ruta
• Remedios para problemas comunes
• Configuración
• Checkers disponibles
• Automatización de cargo-spellcheck