Skip to content

Update YAML settings in configure-coderabbit.md #40

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 2 commits into from
Apr 18, 2024
Merged
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
Add configuration for languagetool integration in configure-coderab…
…bit.md
  • Loading branch information
hasit committed Apr 17, 2024
commit 56184b2cfaa24e0573fcbd13cc17890f6a12c780
15 changes: 15 additions & 0 deletions docs/guides/configure-coderabbit.md
Original file line number Diff line number Diff line change
@@ -125,6 +125,14 @@ YAML settings:
- **`enabled`**: Enable integration, defaults to true.
- **`shellcheck`**: Configuration for `shellcheck` integration.
- **`enabled`**: Enable integration, defaults to true.
- **`languagetool`**: Configuration for `languagetool` integration.
- **`enabled`**: Enable integration, defaults to true.
- **`level`**: The level of the rule. Can be one `default` or `picky`. If set to `picky`, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.
- **`enabled_rules`**: IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule.
- **`disabled_rules`**: IDs of rules to be disabled.
- **`enabled_categories`**: IDs of categories to be enabled.
- **`disabled_categories`**: IDs of categories to be disabled.
- **`enabled_only`**: Only the rules and categories whose IDs are specified with `enabled_rules` or `enabled_categories` are enabled.

```yaml
ast-grep:
@@ -144,6 +152,13 @@ YAML settings:
enabled: true
shellcheck:
enabled: true
languagetool:
enabled: true
enabled_only: false
level: default
enabled_categories:
- "TON_ACADEMIC"
- "CASING"
```

5. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.