From 8c529b87a9e4298856d30aa72500edf885b4711d Mon Sep 17 00:00:00 2001 From: Ivan Gagarinov Date: Thu, 29 Aug 2024 16:32:10 +0500 Subject: [PATCH] update readme --- README.md | 18 ++++++++--------- README.ru.md | 28 ++++++++++++++------------ ignored_languagetool_errors | 40 +++++++++++++++++++++++++++++++++++++ 3 files changed, 64 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d577b20..d43dd7e 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,19 @@ ## Checking errors ```bash -docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js check +docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check ``` Example: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js check /content/**/*.md +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check /content/**/*.md ``` Help: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js check -h +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check -h Usage: run check [options] [dir_path] @@ -37,19 +37,19 @@ Options: ## Fixing errors: ```bash -docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js fix +docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix ``` Example: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js fix /content/**/*.md +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix /content/**/*.md ``` Help: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js fix -h +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix -h Usage: run fix [options] @@ -64,17 +64,17 @@ Options: ## To get wrong words: ```bash -docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js words +docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words ``` Example: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js words /content/**/*.md +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words /content/**/*.md ``` ```bash -docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js words -h +docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words -h Options: -r, --rules "rule1, rule2, ..." languagetools rules diff --git a/README.ru.md b/README.ru.md index 8fcbe95..a71e1d3 100644 --- a/README.ru.md +++ b/README.ru.md @@ -11,7 +11,7 @@ Для запуска проверки нужно выполнить команду: ```bash -docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js check +docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check ``` * *directory* — директория, внутри которой выполняется работа, например, может быть текущая директория *\./*. Директория связывается с директорией */content* в контейнере @@ -20,13 +20,13 @@ docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run Пример: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js check /content/**/*.md +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check /content/**/*.md ``` Справка: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js check -h +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check -h Usage: run check [options] [dir_path] @@ -53,38 +53,40 @@ Options: * Во-вторых, утилита проверяет конфиг [плагина languagtool для VSCode](https://marketplace.visualstudio.com/items?itemName=davidlday.languagetool-linter), который обычно находится по пути *.vscode/settings.json*. Слова из него так же игнорятся, как в предыдущем способе * Третий способ уже отличается тем, что он игнорит конкретные места с ошибками. Пример: утилита выдает ошибку на множественное использование пробелов, а эти пробелы нам нужны для стилизации таблицы. Чтобы утилита игнорила такие ошибки, достаточно создать файл *ignored_languagetool_errors* в директории, которая привязывается к */context*. В этот файл нужно скопировать вывод с ошибками (вместе с разделительными символами). Пример такого файла [можно найти в этом репо](/ignored_languagetool_errors). Так же утилита может создать сама этот файл командой ```bash - docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js ignore + docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js ignore ``` То есть используется команда `ignore` вместо `check`. В остальном команда не отличается. После выполнения этой команды создастся файл *ignored_languagetool_errors*, в него будут помещены все текущие ошибки. При желании путь к файлу можно поменять с помощью опции `--ignore` (см. справку) - Если файл будет отредактирован, добавятся или удалятся строки, то утилита может снова ругаться на такие ошибки, так как тут идет привязка к конкретному контексту. + Если файл будет отредактирован, добавятся или удалятся строки, то утилита может снова ругаться на такие ошибки, так как тут идет привязка к конкретному контексту. Утилита всегда только дополняет файл с ошибками. ## Сценарий работы Обычный сценарий работы с утилитой выглядит так: -* Проверяете ошибки в тексте с помощью команды *check* +* Проверяете ошибки в тексте с помощью команды **check** * Исправляете нужные ошибки - +* Перепроверяете, что остались только ложные ошибки, которые нужно добавить в игнор +* Добавляете ложные ошибки в игнор через добавление слов или с помощью команды **ignore** +* Снова проверяете ошибки командой **check**, убеждаетесь, что вывод чист ## Автоматическое исправление ошибок Утилита умеет автоматически исправлять некоторые ошибки. Но делает это не всегда хорошо и только если есть варианты для замены слов. Некоторые ошибки, особенно стилистические, не предполагают таких вариантов. Утилита в таком случае не поправит ошибку. Утилита перезаписывает файлы при исправлении, поэтому этой функциональностью нужно пользоваться осторожно. Рекомендуется исправлять вручную. ```bash -docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js fix +docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix ``` Пример: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js fix /content/**/*.md +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix /content/**/*.md ``` Справка: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js fix -h +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix -h Usage: run fix [options] @@ -101,19 +103,19 @@ Options: Утилита может записать список слов, в которых нашла ошибка. Это бывает нужно, если вы хотите добавить слова в игнор. По умолчанию слова запишутся в файл *wrong_words.txt*: ```bash -docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js words +docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words ``` Пример: ```bash -docker run --rm -v ./fixtures:/content hexlet/languagetool-cli node ./bin/run.js words /content/**/*.md +docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words /content/**/*.md ``` Справка: ```bash -docker run --rm -v ./:/content hexlet/languagetool-cli node ./bin/run.js words -h +docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words -h Options: -r, --rules "rule1, rule2, ..." languagetools rules diff --git a/ignored_languagetool_errors b/ignored_languagetool_errors index f691560..4637d16 100644 --- a/ignored_languagetool_errors +++ b/ignored_languagetool_errors @@ -10,3 +10,43 @@ README.ru.md:38:43:7 Предлагаемые варианты: Справку ------------------------ +README.ru.md:35:43:4 +...Пример такого файла [можно найти в этом репо](/ignored_languagetool_errors). Так же ... +Возможно найдена орфографическая ошибка. +Предлагаемые варианты: +депо, рено, репа, резо, пепо, реп, репе, репно, репою, репой, репок, репов, репс, репу, репы, рико, рип, рипа, рипе, рипою, рипой, рипп, рипу, рипы, рябо, ре по, реп о +------------------------ +README.ru.md:37:43:2 +... может создать сама этот файл командой ```bash ``` То есть используется ко... +Повтор пробела +Предлагаемые варианты: + +------------------------ +README.ru.md:40:43:2 +...ма этот файл командой ```bash ``` То есть используется команда `` вместо `... +Повтор пробела +Предлагаемые варианты: + +------------------------ +README.ru.md:40:43:7 +...уется команда `` вместо ``. В остальном команда не отличается. После выполнения этой ко... +Предлог «в» предполагает употребление существительного в винительном или предложном падеже: «команде» +Предлагаемые варианты: +команде +------------------------ +README.ru.md:40:43:7 +... можно поменять с помощью опции `` (см. справку) Если файл будет отредактирован, доб... +Это предложение не начинается с заглавной буквы. +Предлагаемые варианты: +Справку +------------------------ +README.ru.md:42:43:2 +...енять с помощью опции `` (см. справку) Если файл будет отредактирован, добавятс... +Повтор пробела +Предлагаемые варианты: + +------------------------ +README.ru.md:51:43:10 +...шибки, которые нужно добавить в игнор * Добавляете ложные ошибки в игнор через добавление ... +Пропущена точка или слово ошибочно написано с прописной буквы. +------------------------