Skip to content

Add linter documentation #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add LanguageTool documentation and configuration
  • Loading branch information
hasit committed Jul 15, 2024
commit 191e19e7e3ae21e6bb31cfdde6d8ed0a4a9405a9
37 changes: 37 additions & 0 deletions docs/guides/tools/languagetool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: LanguageTool
sidebar_label: LanguageTool
description: CodeRabbit's guide to LanguageTool.
sidebar_position: 3
---

[LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker.

## Files

LanguageTool will run on files with the following extensions:

- `.md`
- `.mdx`
- `.markdown`
- `.txt`

## Configuration

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.

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:

- `enabled` - Enable or disable LanguageTool.
- `enabled_rules` - Enable specific rules.
- `disabled_rules` - Disable specific rules.
- `enabled_categories` - Enable specific categories.
- `disabled_categories` - Disable specific categories.
- `enabled_only`- Enable only the rules and categories of IDs are specified with 'enabledRules' or 'enabledCategories'.
- `level` - Set the level of feedback to be provided by LanguageTool. The following levels are available:
- `default` - Provides feedback on common issues.
- `picky` - Provides feedback on more issues, rules that you might only find useful when checking formal text.

## Links

- [LanguageTool Rules](https://community.languagetool.org/rule/list?lang=en)
2 changes: 1 addition & 1 deletion docs/guides/tools/markdownlint.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Markdownlint will run on files with the following extensions:
- `.md`
- `.markdown`

## Settings
## Configuration

Markdownlint supports the following config files:

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/tools/ruff.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Ruff will run on files with the following extensions:

- `.py`

## Settings
## Configuration

Ruff supports the following config files:

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/tools/shellcheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ShellCheck will run on files with the following extensions:
- `.ksh`
- `.dash`

## Settings
## Configuration

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

Expand Down
File renamed without changes.