cargo spellcheck

груз-спелкек

Проверьте свое правописание с помощью hunspell и/или nlprule .

Варианты использования

Запустите cargo spellcheck --fix или cargo spellcheck fix , чтобы исправить все комментарии вашей документации, чтобы избежать противных опечаток по всему вашему исходному дереву. Означал, что вспомогательный обзор, а также улучшение CI -проверки после фазы обучения для конкретного лингового лингового индекса.

cargo-spellcheck также является ценным инструментом для запуска от крючков GIT Commit или CI/CD Systems.

Проверьте наличие орфографических и/или грамматических ошибок

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/

Завершают

cargo spellcheck completions для автоматической передачи вашей текущей оболочки через $SHELL ,

или

cargo spellcheck completions --shell zsh

Чтобы явно указать свой тип оболочки.

Обычно это используется как это из файла .rc* вашей оболочки:

source <(cargo spellcheck completions)

Примечание. Существует соответствующая проблема с хлопком (#3508), которая в некоторых случаях делает это.

? Способствовать!

Взносы очень приветствуются!

Как правило, предпочтительным способом сделать это, чтобы прокомментировать в том случае, который вы хотели бы заняться реализацией/исправлением.

Обычно следует первоначальный PR, в котором тогда обсуждается реализация и итеративно утончена. Не нужно все это правильно в первый раз!

Документация

• Особенности и дорожная карта
• Среды для общих проблем
• Конфигурация
• Доступные шашки
• Автоматизация cargo-spellcheck