LanguageTool

CodeRabbit’s guide to LanguageTool.

LanguageTool is a style and grammar checker.

Files

LanguageTool will run on files with the following extensions:

• .md
• .mdx
• .markdown
• .txt

The following files are excluded:

• CMakeLists.txt
• requirements.txt

Configuration

enabled · boolean · default: true

Enable LanguageTool: Enable LanguageTool integration.

enabled_rules · array of string · default: []

IDs of rules to be enabled. The rule won’t run unless ‘level’ is set to a level that activates the rule.

disabled_rules · array of string · default: []

IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled.

enabled_categories · array of string · default: []

IDs of categories to be enabled.

disabled_categories · array of string · default: []

IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled.

enabled_only · boolean · default: false

Run only the rules and categories listed in enabled_rules or enabled_categories, instead of the default set.

With enabled_only: true, at least one rule or category is required. If both lists are empty, CodeRabbit skips LanguageTool and reports an error.

level · enum · default: "default"

If set to ‘picky’, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.

One of: default, picky

.coderabbit.yaml

.coderabbit.yaml

reviews:
  tools:
    languagetool:
      enabled: true
      enabled_rules: []
      disabled_rules: []
      enabled_categories: []
      disabled_categories: []
      enabled_only: false
      level: "default"

Web UI

In your organization or repository settings, go to Reviews → Tools and turn the tool on or off with its toggle. To change its other settings, click the settings icon next to the toggle.

LanguageTool’s style and grammar check depends on the language selected in CodeRabbit’s configuration. You can set the language by setting the language field in your project’s .coderabbit.yaml file or setting the “Review Language” field in CodeRabbit’s settings page.

LanguageTool only runs when the hosted LanguageTool service credentials are available in the CodeRabbit environment.

Always-disabled categories and rules

The following categories are always disabled:

• TYPOS - Typo detection
• TYPOGRAPHY - Typography issues
• CASING - Casing issues

The following rules are always disabled:

• EN_UNPAIRED_BRACKETS - Unpaired brackets
• EN_UNPAIRED_QUOTES - Unpaired quotes

Profile behavior

In Chill mode, LanguageTool filters out noisy rule patterns:

• QB_NEW_EN* - Experimental “There might be a mistake here” rules that generate many false positives

In Assertive mode, CodeRabbit still filters the noisy QB_NEW_EN* rules, but reports the remaining findings.

Links

• LanguageTool Rules