cargo spellcheck

Carga-Spellcheck

Verifique sua ortografia com hunspell e/ou nlprule .

Casos de uso

Execute cargo spellcheck --fix ou cargo spellcheck fix para corrigir todos os seus comentários de documentação para evitar erros de digitação desagradáveis ​​em toda a sua árvore de origem. Significava uma revisão simplificadora do ajudante, além de melhorar as verificações de IC após uma fase de aprendizado para uma linguagem específica de personalização/tópico.

cargo-spellcheck também é uma ferramenta valiosa para executar a partir de ganchos de comprometimento Git ou sistemas de CI/CD.

Verifique se há erros de ortografia e/ou gramática

cargo spellcheck check

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

Aplique sugestões interativamente

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 

Instalação

cargo install --locked cargo-spellcheck

O sinalizador --locked é a maneira preferida de instalar para obter o conjunto de dependências testado.

No OS X, você precisa garantir que libclang.dylib possa ser encontrado pelo vinculador

que pode ser alcançado definindo DYLB_FALLBACK_LIBRARY_PATH :

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

No Linux, o arquivo é libclang.so , que pode ser instalado via:

 apt-get install libclang-dev

Depois, você pode definir a variável LIBCLANG_PATH via:

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

Conclusões

cargo spellcheck completions para automatização automática de seu shell atual via $SHELL ,

ou

cargo spellcheck completions --shell zsh

Para especificar explicitamente o seu tipo de shell.

Geralmente é uso assim do arquivo .rc* do seu shell:

source <(cargo spellcheck completions)

NOTA: Existe um problema relevante de palmas (#3508) que faz com que isso falhe em alguns casos.

? Contribuir!

As contribuições são muito bem -vindas!

Geralmente, a maneira preferida de fazê -lo é comentar em uma questão que você gostaria de resolver a implementação/correção.

Isso geralmente é seguido por um RP inicial, onde a implementação é discutida e refinada iterativamente. Não há necessidade de resolver tudo da primeira vez!

Documentação

• Recursos e roteiro
• Remédios para problemas comuns
• Configuração
• Damas disponíveis
• Automação de cargo-spellcheck