Skip to content

Split the tools page into explainer and reference pages #325

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Split the tools page into explainer and reference pages #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
74 changes: 74 additions & 0 deletions docs/tools/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: List of supported tools
description: Overview of CodeRabbit's supported linters and security analysis tools
---

This is a list of the third-party open-source linters and security analysis tools that CodeRabbit uses to generate code reviews.

For more information about fine-tuning the CodeRabbit configuration of a tool, click that tool's name in the following list.

For an overview of how CodeRabbit uses these tools when generating code reviews, as well as general information about controlling their use, see [Configure third-party tools](/tools/).

| Technology | Tools | Category |
| :-------------------------- | :--------------------------------------------------------- | :-------------------------------------------------- |
| All | [Gitleaks][Gitleaks], [Pipeline Remediation][Pipeline] | Code Security, CI/CD |
| Azure DevOps Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
| CircleCI | [CircleCI][CircleCI], [Pipeline Remediation][Pipeline] | Configuration Validation, CI/CD Failure Remediation |
| CloudFormation | [Checkov][Checkov] | Code Security |
| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
| CSS | [Biome][Biome] | Code Quality |
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation |
| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
| Go | [golangci-lint][golangci-lint] | Code Quality |
| Helm | [Checkov][Checkov] | Code Security |
| Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| JSON, JSONC | [Biome][Biome] | Code Quality |
| JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| Kotlin | [detekt][detekt] | Code Quality |
| Kubernetes | [Checkov][Checkov] | Code Security |
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
| PHP | [PHPStan][PHPStan] | Code Quality |
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
| Java | [PMD][PMD] | Code Quality |
| Protobuf | [Buf][Buf] | Code Quality |
| Python | [Ruff][Ruff] | Code Quality |
| Regal | [Regal][Regal] | Code Quality |
| Ruby | [RuboCop][RuboCop] | Code Quality |
| Semgrep | [Semgrep][Semgrep] | Code Security |
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
| Shopify | [Shopify CLI][ShopifyCLI] | Code Quality |
| SQL | [SQLFluff][SQLFluff] | Code Quality |
| Swift | [SwiftLint][SwiftLint] | Code Quality |
| Terraform | [Checkov][Checkov] | Code Security |
| TSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| Typescript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| YAML | [YAMLlint][YAMLlint] | Code Quality |
| Prisma | [Prisma Lint][PrismaLint] | Code Quality |

[ShellCheck]: /tools/shellcheck.md
[SQLFluff]: /tools/sqlfluff.md
[Ruff]: /tools/ruff.md
[markdownlint]: /tools/markdownlint.md
[LanguageTool]: /tools/languagetool.md
[Biome]: /tools/biome.md
[Hadolint]: /tools/hadolint.md
[SwiftLint]: /tools/swiftlint.md
[PHPStan]: /tools/phpstan.md
[golangci-lint]: /tools/golangci-lint.md
[YAMLlint]: /tools/yamllint.md
[Gitleaks]: /tools/gitleaks.md
[Checkov]: /tools/checkov.md
[detekt]: /tools/detekt.md
[RuboCop]: /tools/rubocop.md
[Buf]: /tools/buf.md
[actionlint]: /tools/actionlint.md
[Regal]: /tools/regal.md
[PMD]: /tools/pmd.md
[Cppcheck]: /tools/cppcheck.md
[CircleCI]: /tools/circleci.md
[Semgrep]: /tools/semgrep.md
[Pipeline]: /tools/pipeline-remediation.md
[PrismaLint]: /tools/prisma-lint.md
[oxlint]: /tools/oxlint.md
[ShopifyCLI]: /tools/shopify-cli.md
70 changes: 5 additions & 65 deletions docs/tools/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Configure third-party tool use
description: Overview of CodeRabbit's supported linters and security analysis tools.
---

This page provides an overview of how CodeRabbit uses third-party open-source tools to deliver its multifaceted code reviews. For a complete list of supported tools, see [Supported tools](/tools/list).

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

Expand Down Expand Up @@ -40,68 +42,6 @@ Remove extraneous f prefix
(F541)
```

## Supported Tools

| Technology | Tools | Category |
| :-------------------------- | :--------------------------------------------------------- | :-------------------------------------------------- |
| All | [Gitleaks][Gitleaks], [Pipeline Remediation][Pipeline] | Code Security, CI/CD |
| Azure DevOps Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
| CircleCI | [CircleCI][CircleCI], [Pipeline Remediation][Pipeline] | Configuration Validation, CI/CD Failure Remediation |
| CloudFormation | [Checkov][Checkov] | Code Security |
| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
| CSS | [Biome][Biome] | Code Quality |
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation |
| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
| Go | [golangci-lint][golangci-lint] | Code Quality |
| Helm | [Checkov][Checkov] | Code Security |
| Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| JSON, JSONC | [Biome][Biome] | Code Quality |
| JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| Kotlin | [detekt][detekt] | Code Quality |
| Kubernetes | [Checkov][Checkov] | Code Security |
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
| PHP | [PHPStan][PHPStan] | Code Quality |
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
| Java | [PMD][PMD] | Code Quality |
| Protobuf | [Buf][Buf] | Code Quality |
| Python | [Ruff][Ruff] | Code Quality |
| Regal | [Regal][Regal] | Code Quality |
| Ruby | [RuboCop][RuboCop] | Code Quality |
| Semgrep | [Semgrep][Semgrep] | Code Security |
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
| Shopify | [Shopify CLI][ShopifyCLI] | Code Quality |
| SQL | [SQLFluff][SQLFluff] | Code Quality |
| Swift | [SwiftLint][SwiftLint] | Code Quality |
| Terraform | [Checkov][Checkov] | Code Security |
| TSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| Typescript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
| YAML | [YAMLlint][YAMLlint] | Code Quality |
| Prisma | [Prisma Lint][PrismaLint] | Code Quality |

[ShellCheck]: ./shellcheck.md
[SQLFluff]: ./sqlfluff.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
[detekt]: ./detekt.md
[RuboCop]: ./rubocop.md
[Buf]: ./buf.md
[actionlint]: ./actionlint.md
[Regal]: ./regal.md
[PMD]: ./pmd.md
[Cppcheck]: ./cppcheck.md
[CircleCI]: ./circleci.md
[Semgrep]: ./semgrep.md
[Pipeline]: ./pipeline-remediation.md
[PrismaLint]: ./prisma-lint.md
[oxlint]: ./oxlint.md
[ShopifyCLI]: ./shopify-cli.md
## What's next

- For a complete list of tools that CodeRabbit supports, see [Supported tools](/tools/list).
1 change: 1 addition & 0 deletions sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ const sidebars: SidebarsConfig = {
label: "Supported tools",
collapsed: true,
items: [
"tools/list",
"tools/actionlint",
"tools/biome",
"tools/buf",
Expand Down