Skip to content

Add table for Supported Tools by languages #63

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.

Sign up for GitHub

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 3 commits into from
Jul 16, 2024
Merged

Add table for Supported Tools by languages #63

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce6e11a
Add table for Supported Tools by languages
hasit Jul 16, 2024
44372e7
Update supported tools table and documentation
hasit Jul 16, 2024
24a2825
Update tool configuration documentation
hasit Jul 16, 2024
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
46 changes: 33 additions & 13 deletions docs/guides/tools/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ CodeRabbit supports customizing the strictness of tools by setting `reviews.prof
- `Chill` - Yields less feedback, that may be considered lenient.
- `Assertive` - Yields more feedback, that may be considered nit-picky.

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.
Apart from the overall profile, you can also configure each tool by providing a path to 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.

## Checking Tool Output

Expand All @@ -36,15 +36,35 @@ Remove extraneous f prefix

## Supported Tools

- [ShellCheck](./shellcheck.md)
- [Ruff](./ruff.md)
- [Markdownlint](./markdownlint.md)
- [LanguageTool](./languagetool.md)
- [Biome](./biome.md)
- [Hadolint](./hadolint.md)
- [SwiftLint](./swiftlint.md)
- [PHPStan](./phpstan.md)
- [golangci-lint](./golangci-lint.md)
- [YamlLint](./yamllint.md)
- [Gitleaks](./gitleaks.md)
- [Checkov](./checkov.md)
| Language | Tool |
|----------------|----------------|
| All | [Gitleaks][Gitleaks] |
| Text | [LanguageTool][LanguageTool] |
| Bash | [ShellCheck][ShellCheck] |
| Python | [Ruff][Ruff] |
| Markdown | [Markdownlint][Markdownlint], [LanguageTool][LanguageTool] |
| Javascript | [Biome][[Biome]] |
| Typescript | [Biome][[Biome]] |
| JSX | [Biome][[Biome]] |
| TSX | [Biome][[Biome]] |
| CSS | [Biome][[Biome]] |
| JSON, JSONC | [Biome][Biome] |
| Docker | [Hadolint][Hadolint] |
| Swift | [SwiftLint][SwiftLint] |
| PHP | [PHPStan][PHPStan] |
| Go | [golangci-lint][golangci-lint] |
| YAML | [YamlLint][YamlLint] |
| Infrastructure as Code (IaC) | [Checkov][Checkov] |

[ShellCheck]: ./shellcheck.md
[Ruff]: ./ruff.md
[Markdownlint]: ./markdownlint.md
[LanguageTool]: ./languagetool.md
[Biome]: ./biome.md
[Hadolint]: ./hadolint.md
[SwiftLint]: ./swiftlint.md
[PHPStan]: ./phpstan.md
[golangci-lint]: ./golangci-lint.md
[YamlLint]: ./yamllint.md
[Gitleaks]: ./gitleaks.md
[Checkov]: ./checkov.md