Edit

LanguageTool

This is BETA. The behavior of this tool might change.

Supported Version	Language	Website
4.9.1	Java 14.0.1	https://languagetool.org

LanguageTool is a proofreading tool for English, French, German, and other languages. It finds many mistakes like grammar errors, misspells, and so on.

Getting Started

To start using LanguageTool, enable it in your repository settings.

Limitation

Because LanguageTool does not support any markup languages like HTML, Markdown, or LaTeX, Sider analyzes only .txt files by default. If you want to analyze your files written in some markup languages, you can do it by configuring your sider.yml, for example:

linter:
  languagetool:
    ext: [.md, .html]

But the analysis may report many false positives. In such a case, we recommend closing such issues or disabling such rules via your sider.yml like this:

linter:
  languagetool:
    ext: [.md, .html]
    disable:
      - EN_QUOTES # To suppress false positives about quotes, e.g. `<a class="normal">`

Configuration

Here is an example configuration for LanguageTool via sider.yml:

linter:
  languagetool:
    target: docs/
    ext: [.md, .tex]
    exclude:
      - "**/test/*"
      - "**/special.{md,tex}"
    language: en-GB
    encoding: ISO-8859-1
    disable:
      - EN_QUOTES
      - UPPERCASE_SENTENCE_START
    enable:
      - EN_A_VS_AN
    enabledonly: true
    disablecategories:
      - CASING
    enablecategories:
      - MISC

You can customize the analysis via the following options:

Name	Type	Default
root_dir	string	-
target	string	.
ext	string[]	[".txt"]
exclude	string[]	["**/{requirements,robots}.txt"]
language	string	en-US
encoding	string	UTF-8
disable	string[]	[]
enable	string[]	[]
enabledonly	boolean	false
disablecategories	string[]	[]
enablecategories	string[]	[]

target

This option allows you to specify a directory to be analyzed. It is useful to use together with the ext option.

In the example below, Sider analyzes *.md and *.markdown files under the docs/ directory.

linter:
  languagetool:
    target: docs/
    ext: [.md, .markdown]

ext

This option allows you to specify extensions of files to be analyzed.

exclude

This option allows you to specify glob patterns that you want to exclude from your analysis.

language

This option allows you to specify a language used in analyzed files, e.g. en or en-US. Note that you need to specify it with a variant (e.g. en-US or en-GB) to work the spell checking well.

See the official document for supported languages.

encoding

This option allows you to specify a file encoding.

disable

This option allows you to disable any rules, e.g. EN_QUOTES or UPPERCASE_SENTENCE_START.

enable

This option allows you to enable any rules, e.g. EN_QUOTES or UPPERCASE_SENTENCE_START. It is useful to use together with the enabledonly option.

In the example below, only EN_QUOTES and UPPERCASE_SENTENCE_START rules are used for your analysis.

linter:
  languagetool:
    enable:
      - EN_QUOTES
      - UPPERCASE_SENTENCE_START
    enabledonly: true

enabledonly

This option allows you to enable only the specified rules.

disablecategories

This option allows you to disable any rule categories, e.g. CASING or TYPOS.

enablecategories

This option allows you to enable any rule categories, e.g. CASING or TYPOS. It is useful to use together with the enabledonly option.

In the example below, only CASING and TYPOS categories are used for your analysis.

linter:
  languagetool:
    enablecategories:
      - CASING
      - TYPOS
    enabledonly: true