1.0.13 • Published 9 months ago

languagetool-cli v1.0.13

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

languagetool-cli

Command line interface towards languagetool (https://languagetool.org)

This is some kind of work in progress as a side-kick besides writing a book. For a list of open issues, please refer to the to-dos.

Dependencies

You have to have a running LanguageTool-Server (see https://dev.languagetool.org/http-server) on port 8081

usage

Usage: language-tool [options] [files...]

Arguments:
  files                                  Input files

Options:
  -v, --verbose                          Debug output (default: false)
  --enabled-rules <rules...>
  --disabled-rules <rules...>
  --enabled-categories <categories...>
  --disabled-categories <categories...>
  --only-enabled                         Use enabled rules only (default: false)
  -r, --rule-config <files...>
  --url <url>
  --concurrent <concurrent>
  --output-format <format>               Output format (choices: "pretty", "vim", "reviewdog", default: "pretty")
  -l, --language <language>              Sprache (default: "auto")
  -m, --mother-tongue <mother-tongue>    Mother tongue
  -h, --help                             display help for command

-language, -l

Sets the language to be used.

-mother-tongue, -m

The mother tongue. If set, some more grammar checks are performed

--rule-file, -r

Adds rules that are processed for all files. The syntax is described in Configuration Files below.

You can add as many files as needed

--enabled-rules, --disabled-rules

Enables/disables rules given by rule-id.

--enable-categories, --disable-categories

Enables/disables rules given by rule-id.

--output-format

Output messages a pretty (user friedly) or computer readable (vim, reviewdog) format.

--concurrent

Limit the number of concurrent requests to the LanguageTool-server in parallel. The default is set to 2.

Line and file inline comments

<!-- languagetool-disable-file german_grammar_rule(atembar) -->
<!-- languagetool-enable-file german_grammar_rule(atembar) -->
<!-- languagetool-disable-line german_grammar_rule(atembar) -->
<!-- languagetool-enable-line german_grammar_rule(atembar) -->
<!-- languagetool-disable-next-line german_grammar_rule(atembar) -->
<!-- languagetool-enable-next-line german_grammar_rule(atembar) -->

This needs \<\<TBD>>

Configuration Files

The file contains a simple syntax:

  • Every line can contain a command, which is either disabled or enabled, followed by rules in the for rule-id, followed by an optional token in parens.

  • A line starting with a hash sign ('#') represents a comment

An example:

# missing in lexicon
disable german_grammar_rule(atembar) german_grammar_rule(atembare)

# A Name
disable GERMAN_SPELLER_RULE(Brom)

# This book contains a lot of repeating starts
disable GERMAN_WORD_REPEAT_BEGINNING_RULE
1.0.13

9 months ago

1.0.12

10 months ago

1.0.9

11 months ago

1.0.8

11 months ago

1.0.7

11 months ago

1.0.6

11 months ago

1.0.5

11 months ago

1.0.11

11 months ago

1.0.10

11 months ago

1.0.3-beta.1

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

2 years ago

1.0.1

3 years ago

1.0.2-beta.1

2 years ago

1.0.1-beta.1

3 years ago

1.0.0

3 years ago

1.0.0-beta.7

3 years ago

1.0.0-beta.6

3 years ago

1.0.0-beta.5

3 years ago

1.0.0-beta.4

3 years ago

1.0.0-beta.3

3 years ago

1.0.0-beta.2

3 years ago

1.0.0-beta.1

3 years ago