Skip to content

Commit ba319c5

Browse files
committed
docs: Move linter documentation to tools folder
1 parent 455af2a commit ba319c5

File tree

4 files changed

+40
-24
lines changed

4 files changed

+40
-24
lines changed

docs/guides/linters/linters.md

-23
This file was deleted.
File renamed without changes.

docs/guides/tools/linters.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Tools
3+
sidebar_label: Tools
4+
description: Overview of CodeRabbit's supported linters and security analysis tools.
5+
sidebar_position: 1
6+
---
7+
8+
CodeRabbit supports various linters and security analysis tools to improve the code review process. The output of these tools is used to enhance the feedback provided by CodeRabbit, making it possible to provide 1-click fixes for common issues.
9+
10+
## Enabling/Disabling Tools
11+
12+
You can enable or disable tools by setting `reviews.tools.<linter>.enabled` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → Linter → Enabled" field in CodeRabbit's settings page.
13+
14+
## Customizing Tools
15+
16+
CodeRabbit supports customizing the strictness of tools by setting `reviews.profile` in your project's `.coderabbit.yaml` file or setting the "Review → Profile" field in CodeRabbit's settings page. The following profiles are available:
17+
18+
- `Chill` - Yields less feedback, that may be considered lenient.
19+
- `Assertive` - Yields more feedback, that may be considered nit-picky.
20+
21+
Apart from the overall profile, you can also configure each tool by providing a configuration file (specific to the tool) in your project. This would allow you to further customize the tool's behavior, by enabling/disabling specific rules, setting rule severity, etc.
22+
23+
## Checking Tool Output
24+
25+
When a tool is enabled, CodeRabbit will run it on your change request and attach the output under "Review details" comment in the change request. The output will be displayed in a structured format, with information on the file, line number, and the issue detected. For example:
26+
27+
```text
28+
Ruff
29+
fib.py
30+
21-21: f-string without any placeholders
31+
32+
Remove extraneous f prefix
33+
34+
(F541)
35+
```
36+
37+
## Supported Tools
38+
39+
- [Ruff](./ruff.md)

docs/guides/linters/ruff.md renamed to docs/guides/tools/ruff.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Ruff
33
sidebar_label: Ruff
4-
description: Overview of CodeRabbit's supported linters and security analysis tools.
4+
description: CodeRabbit's guide to Ruff.
55
sidebar_position: 1
66
---
77

0 commit comments

Comments
 (0)