Skip to content

Commit 191e19e

Browse files
committed
Add LanguageTool documentation and configuration
1 parent 1d04172 commit 191e19e

File tree

5 files changed

+40
-3
lines changed

5 files changed

+40
-3
lines changed

docs/guides/tools/languagetool.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: LanguageTool
3+
sidebar_label: LanguageTool
4+
description: CodeRabbit's guide to LanguageTool.
5+
sidebar_position: 3
6+
---
7+
8+
[LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker.
9+
10+
## Files
11+
12+
LanguageTool will run on files with the following extensions:
13+
14+
- `.md`
15+
- `.mdx`
16+
- `.markdown`
17+
- `.txt`
18+
19+
## Configuration
20+
21+
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.
22+
23+
CodeRabbit allows further configuring LanguageTool by setting specific rules and categories to be enabled/disabled. This can be done under the `reviews.tools.languagetool` field in your project's `.coderabbit.yaml` file or setting the various options under "Review → Tools → LanguageTool" in CodeRabbit's settings page. The following options are available:
24+
25+
- `enabled` - Enable or disable LanguageTool.
26+
- `enabled_rules` - Enable specific rules.
27+
- `disabled_rules` - Disable specific rules.
28+
- `enabled_categories` - Enable specific categories.
29+
- `disabled_categories` - Disable specific categories.
30+
- `enabled_only`- Enable only the rules and categories of IDs are specified with 'enabledRules' or 'enabledCategories'.
31+
- `level` - Set the level of feedback to be provided by LanguageTool. The following levels are available:
32+
- `default` - Provides feedback on common issues.
33+
- `picky` - Provides feedback on more issues, rules that you might only find useful when checking formal text.
34+
35+
## Links
36+
37+
- [LanguageTool Rules](https://community.languagetool.org/rule/list?lang=en)

docs/guides/tools/markdownlint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Markdownlint will run on files with the following extensions:
1414
- `.md`
1515
- `.markdown`
1616

17-
## Settings
17+
## Configuration
1818

1919
Markdownlint supports the following config files:
2020

docs/guides/tools/ruff.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Ruff will run on files with the following extensions:
1313

1414
- `.py`
1515

16-
## Settings
16+
## Configuration
1717

1818
Ruff supports the following config files:
1919

docs/guides/tools/shellcheck.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ShellCheck will run on files with the following extensions:
1616
- `.ksh`
1717
- `.dash`
1818

19-
## Settings
19+
## Configuration
2020

2121
CodeRabbit will use the following settings based on the profile selected:
2222

File renamed without changes.

0 commit comments

Comments
 (0)