Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit7042a8a

Browse files
authored
Split the tools page into explainer and reference pages (coderabbitai#325)
Split the tools page into seaprate explainer andreferences pages.Fixescoderabbitai#305.
1 parent81a641c commit7042a8a

File tree

3 files changed

+80
-65
lines changed

3 files changed

+80
-65
lines changed

‎docs/tools/list.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title:List of supported tools
3+
description:Overview of CodeRabbit's supported linters and security analysis tools
4+
---
5+
6+
This is a list of the third-party open-source linters and security analysis tools that CodeRabbit uses to generate code reviews.
7+
8+
For more information about fine-tuning the CodeRabbit configuration of a tool, click that tool's name in the following list.
9+
10+
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/).
11+
12+
| Technology| Tools| Category|
13+
| :--------------------------| :---------------------------------------------------------| :--------------------------------------------------|
14+
| All|[Gitleaks][Gitleaks],[Pipeline Remediation][Pipeline]| Code Security, CI/CD|
15+
| Azure DevOps Pipelines|[Pipeline Remediation][Pipeline]| CI/CD Failure Remediation|
16+
| CircleCI|[CircleCI][CircleCI],[Pipeline Remediation][Pipeline]| Configuration Validation, CI/CD Failure Remediation|
17+
| CloudFormation|[Checkov][Checkov]| Code Security|
18+
| Cppcheck|[Cppcheck][Cppcheck]| Code Quality|
19+
| CSS|[Biome][Biome]| Code Quality|
20+
| Docker|[Hadolint][Hadolint],[Checkov][Checkov]| Code Quality, Code Security|
21+
| GitHub Actions|[actionlint][actionlint],[Pipeline Remediation][Pipeline]| Code Quality, CI/CD Failure Remediation|
22+
| GitLab Pipelines|[Pipeline Remediation][Pipeline]| CI/CD Failure Remediation|
23+
| Go|[golangci-lint][golangci-lint]| Code Quality|
24+
| Helm|[Checkov][Checkov]| Code Security|
25+
| Javascript|[Biome][Biome],[oxlint][oxlint]| Code Quality|
26+
| JSON, JSONC|[Biome][Biome]| Code Quality|
27+
| JSX|[Biome][Biome],[oxlint][oxlint]| Code Quality|
28+
| Kotlin|[detekt][detekt]| Code Quality|
29+
| Kubernetes|[Checkov][Checkov]| Code Security|
30+
| Markdown|[markdownlint][markdownlint],[LanguageTool][LanguageTool]| Code Quality, Grammar Checking|
31+
| PHP|[PHPStan][PHPStan]| Code Quality|
32+
| Plaintext|[LanguageTool][LanguageTool]| Grammar and Spell Checking|
33+
| Java|[PMD][PMD]| Code Quality|
34+
| Protobuf|[Buf][Buf]| Code Quality|
35+
| Python|[Ruff][Ruff]| Code Quality|
36+
| Regal|[Regal][Regal]| Code Quality|
37+
| Ruby|[RuboCop][RuboCop]| Code Quality|
38+
| Semgrep|[Semgrep][Semgrep]| Code Security|
39+
| Shell (sh, bash, ksh, dash)|[ShellCheck][ShellCheck]| Code Quality|
40+
| Shopify|[Shopify CLI][ShopifyCLI]| Code Quality|
41+
| SQL|[SQLFluff][SQLFluff]| Code Quality|
42+
| Swift|[SwiftLint][SwiftLint]| Code Quality|
43+
| Terraform|[Checkov][Checkov]| Code Security|
44+
| TSX|[Biome][Biome],[oxlint][oxlint]| Code Quality|
45+
| Typescript|[Biome][Biome],[oxlint][oxlint]| Code Quality|
46+
| YAML|[YAMLlint][YAMLlint]| Code Quality|
47+
| Prisma|[Prisma Lint][PrismaLint]| Code Quality|
48+
49+
[ShellCheck]:/tools/shellcheck.md
50+
[SQLFluff]:/tools/sqlfluff.md
51+
[Ruff]:/tools/ruff.md
52+
[markdownlint]:/tools/markdownlint.md
53+
[LanguageTool]:/tools/languagetool.md
54+
[Biome]:/tools/biome.md
55+
[Hadolint]:/tools/hadolint.md
56+
[SwiftLint]:/tools/swiftlint.md
57+
[PHPStan]:/tools/phpstan.md
58+
[golangci-lint]:/tools/golangci-lint.md
59+
[YAMLlint]:/tools/yamllint.md
60+
[Gitleaks]:/tools/gitleaks.md
61+
[Checkov]:/tools/checkov.md
62+
[detekt]:/tools/detekt.md
63+
[RuboCop]:/tools/rubocop.md
64+
[Buf]:/tools/buf.md
65+
[actionlint]:/tools/actionlint.md
66+
[Regal]:/tools/regal.md
67+
[PMD]:/tools/pmd.md
68+
[Cppcheck]:/tools/cppcheck.md
69+
[CircleCI]:/tools/circleci.md
70+
[Semgrep]:/tools/semgrep.md
71+
[Pipeline]:/tools/pipeline-remediation.md
72+
[PrismaLint]:/tools/prisma-lint.md
73+
[oxlint]:/tools/oxlint.md
74+
[ShopifyCLI]:/tools/shopify-cli.md

‎docs/tools/tools.md‎

Lines changed: 5 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Configure third-party tool use
33
description:Overview of CodeRabbit's supported linters and security analysis tools.
44
---
55

6+
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).
7+
68
```mdx-code-block
79
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
810
@@ -40,68 +42,6 @@ Remove extraneous f prefix
4042
(F541)
4143
```
4244

43-
##Supported Tools
44-
45-
| Technology| Tools| Category|
46-
| :--------------------------| :---------------------------------------------------------| :--------------------------------------------------|
47-
| All|[Gitleaks][Gitleaks],[Pipeline Remediation][Pipeline]| Code Security, CI/CD|
48-
| Azure DevOps Pipelines|[Pipeline Remediation][Pipeline]| CI/CD Failure Remediation|
49-
| CircleCI|[CircleCI][CircleCI],[Pipeline Remediation][Pipeline]| Configuration Validation, CI/CD Failure Remediation|
50-
| CloudFormation|[Checkov][Checkov]| Code Security|
51-
| Cppcheck|[Cppcheck][Cppcheck]| Code Quality|
52-
| CSS|[Biome][Biome]| Code Quality|
53-
| Docker|[Hadolint][Hadolint],[Checkov][Checkov]| Code Quality, Code Security|
54-
| GitHub Actions|[actionlint][actionlint],[Pipeline Remediation][Pipeline]| Code Quality, CI/CD Failure Remediation|
55-
| GitLab Pipelines|[Pipeline Remediation][Pipeline]| CI/CD Failure Remediation|
56-
| Go|[golangci-lint][golangci-lint]| Code Quality|
57-
| Helm|[Checkov][Checkov]| Code Security|
58-
| Javascript|[Biome][Biome],[oxlint][oxlint]| Code Quality|
59-
| JSON, JSONC|[Biome][Biome]| Code Quality|
60-
| JSX|[Biome][Biome],[oxlint][oxlint]| Code Quality|
61-
| Kotlin|[detekt][detekt]| Code Quality|
62-
| Kubernetes|[Checkov][Checkov]| Code Security|
63-
| Markdown|[markdownlint][markdownlint],[LanguageTool][LanguageTool]| Code Quality, Grammar Checking|
64-
| PHP|[PHPStan][PHPStan]| Code Quality|
65-
| Plaintext|[LanguageTool][LanguageTool]| Grammar and Spell Checking|
66-
| Java|[PMD][PMD]| Code Quality|
67-
| Protobuf|[Buf][Buf]| Code Quality|
68-
| Python|[Ruff][Ruff]| Code Quality|
69-
| Regal|[Regal][Regal]| Code Quality|
70-
| Ruby|[RuboCop][RuboCop]| Code Quality|
71-
| Semgrep|[Semgrep][Semgrep]| Code Security|
72-
| Shell (sh, bash, ksh, dash)|[ShellCheck][ShellCheck]| Code Quality|
73-
| Shopify|[Shopify CLI][ShopifyCLI]| Code Quality|
74-
| SQL|[SQLFluff][SQLFluff]| Code Quality|
75-
| Swift|[SwiftLint][SwiftLint]| Code Quality|
76-
| Terraform|[Checkov][Checkov]| Code Security|
77-
| TSX|[Biome][Biome],[oxlint][oxlint]| Code Quality|
78-
| Typescript|[Biome][Biome],[oxlint][oxlint]| Code Quality|
79-
| YAML|[YAMLlint][YAMLlint]| Code Quality|
80-
| Prisma|[Prisma Lint][PrismaLint]| Code Quality|
81-
82-
[ShellCheck]:./shellcheck.md
83-
[SQLFluff]:./sqlfluff.md
84-
[Ruff]:./ruff.md
85-
[markdownlint]:./markdownlint.md
86-
[LanguageTool]:./languagetool.md
87-
[Biome]:./biome.md
88-
[Hadolint]:./hadolint.md
89-
[SwiftLint]:./swiftlint.md
90-
[PHPStan]:./phpstan.md
91-
[golangci-lint]:./golangci-lint.md
92-
[YAMLlint]:./yamllint.md
93-
[Gitleaks]:./gitleaks.md
94-
[Checkov]:./checkov.md
95-
[detekt]:./detekt.md
96-
[RuboCop]:./rubocop.md
97-
[Buf]:./buf.md
98-
[actionlint]:./actionlint.md
99-
[Regal]:./regal.md
100-
[PMD]:./pmd.md
101-
[Cppcheck]:./cppcheck.md
102-
[CircleCI]:./circleci.md
103-
[Semgrep]:./semgrep.md
104-
[Pipeline]:./pipeline-remediation.md
105-
[PrismaLint]:./prisma-lint.md
106-
[oxlint]:./oxlint.md
107-
[ShopifyCLI]:./shopify-cli.md
45+
##What's next
46+
47+
- For a complete list of tools that CodeRabbit supports, see[Supported tools](/tools/list).

‎sidebars.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ const sidebars: SidebarsConfig = {
145145
label:"Supported tools",
146146
collapsed:true,
147147
items:[
148+
"tools/list",
148149
"tools/actionlint",
149150
"tools/biome",
150151
"tools/buf",

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp