Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dzencot committed Aug 29, 2024
1 parent 36a5b59 commit 8c529b8
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 22 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
## Checking errors

```bash
docker run --rm -v ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js check <filePath>
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check <filePath>
```

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]

Expand All @@ -37,19 +37,19 @@ Options:
## Fixing errors:

```bash
docker run --rm -v ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js fix <filePath>
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix <filePath>
```

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] <dirPath>

Expand All @@ -64,17 +64,17 @@ Options:
## To get wrong words:

```bash
docker run --rm -v ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js words <filePath>
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words <filePath>
```

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 ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js words -h
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words -h

Options:
-r, --rules "rule1, rule2, ..." languagetools rules
Expand Down
28 changes: 15 additions & 13 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Для запуска проверки нужно выполнить команду:

```bash
docker run --rm -v ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js check <filePath>
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check <filePath>
```

* *directory* — директория, внутри которой выполняется работа, например, может быть текущая директория *\./*. Директория связывается с директорией */content* в контейнере
Expand All @@ -20,13 +20,13 @@ docker run --rm -v ./<directory>:/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]

Expand All @@ -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 ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js ignore <filePath>
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js ignore <filePath>
```
То есть используется команда `ignore` вместо `check`. В остальном команда не отличается. После выполнения этой команды создастся файл *ignored_languagetool_errors*, в него будут помещены все текущие ошибки. При желании путь к файлу можно поменять с помощью опции `--ignore` (см. справку)

Если файл будет отредактирован, добавятся или удалятся строки, то утилита может снова ругаться на такие ошибки, так как тут идет привязка к конкретному контексту.
Если файл будет отредактирован, добавятся или удалятся строки, то утилита может снова ругаться на такие ошибки, так как тут идет привязка к конкретному контексту. Утилита всегда только дополняет файл с ошибками.

## Сценарий работы

Обычный сценарий работы с утилитой выглядит так:

* Проверяете ошибки в тексте с помощью команды *check*
* Проверяете ошибки в тексте с помощью команды **check**
* Исправляете нужные ошибки

* Перепроверяете, что остались только ложные ошибки, которые нужно добавить в игнор
* Добавляете ложные ошибки в игнор через добавление слов или с помощью команды **ignore**
* Снова проверяете ошибки командой **check**, убеждаетесь, что вывод чист

## Автоматическое исправление ошибок

Утилита умеет автоматически исправлять некоторые ошибки. Но делает это не всегда хорошо и только если есть варианты для замены слов. Некоторые ошибки, особенно стилистические, не предполагают таких вариантов. Утилита в таком случае не поправит ошибку. Утилита перезаписывает файлы при исправлении, поэтому этой функциональностью нужно пользоваться осторожно. Рекомендуется исправлять вручную.

```bash
docker run --rm -v ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js fix <filePath>
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix <filePath>
```

Пример:

```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] <dirPath>
Expand All @@ -101,19 +103,19 @@ Options:
Утилита может записать список слов, в которых нашла ошибка. Это бывает нужно, если вы хотите добавить слова в игнор. По умолчанию слова запишутся в файл *wrong_words.txt*:

```bash
docker run --rm -v ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js words <filePath>
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words <filePath>
```

Пример:

```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 ./<directory>:/content hexlet/languagetool-cli node ./bin/run.js words -h
docker run --rm -v ./<directory>:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words -h
Options:
-r, --rules "rule1, rule2, ..." languagetools rules
Expand Down
40 changes: 40 additions & 0 deletions ignored_languagetool_errors
Original file line number Diff line number Diff line change
Expand Up @@ -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
...шибки, которые нужно добавить в игнор * Добавляете ложные ошибки в игнор через добавление ...
Пропущена точка или слово ошибочно написано с прописной буквы.
------------------------

0 comments on commit 8c529b8

Please sign in to comment.