From ce6e11a3fc43ab97d4d859be962ad0c4a66d46a9 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Tue, 16 Jul 2024 12:51:18 -0700 Subject: [PATCH 1/3] Add table for Supported Tools by languages --- docs/guides/tools/tools.md | 46 +++++++++++++++++++++++++++----------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/docs/guides/tools/tools.md b/docs/guides/tools/tools.md index 6b0a70e8..1067be7f 100644 --- a/docs/guides/tools/tools.md +++ b/docs/guides/tools/tools.md @@ -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 @@ -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 From 44372e74cf4c35677d4b34aa090c2469648794e8 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Tue, 16 Jul 2024 14:06:17 -0700 Subject: [PATCH 2/3] Update supported tools table and documentation --- docs/guides/tools/biome.md | 1 - docs/guides/tools/checkov.md | 1 - docs/guides/tools/detekt.md | 5 ++++ docs/guides/tools/gitleaks.md | 1 - docs/guides/tools/golangci-lint.md | 1 - docs/guides/tools/hadolint.md | 1 - docs/guides/tools/languagetool.md | 1 - docs/guides/tools/markdownlint.md | 1 - docs/guides/tools/phpstan.md | 1 - docs/guides/tools/ruff.md | 1 - docs/guides/tools/shellcheck.md | 1 - docs/guides/tools/swiftlint.md | 1 - docs/guides/tools/tools.md | 43 +++++++++++++++++------------- docs/guides/tools/yamllint.md | 1 - 14 files changed, 29 insertions(+), 31 deletions(-) create mode 100644 docs/guides/tools/detekt.md diff --git a/docs/guides/tools/biome.md b/docs/guides/tools/biome.md index ff9fdc13..6cd64c31 100644 --- a/docs/guides/tools/biome.md +++ b/docs/guides/tools/biome.md @@ -2,7 +2,6 @@ title: Biome sidebar_label: Biome description: CodeRabbit's guide to Biome. -sidebar_position: 5 --- [Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS. diff --git a/docs/guides/tools/checkov.md b/docs/guides/tools/checkov.md index 9600cb97..93a7e3d1 100644 --- a/docs/guides/tools/checkov.md +++ b/docs/guides/tools/checkov.md @@ -2,7 +2,6 @@ title: Checkov sidebar_label: Checkov description: CodeRabbit's guide to Checkov. -sidebar_position: 2 --- [Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations. diff --git a/docs/guides/tools/detekt.md b/docs/guides/tools/detekt.md new file mode 100644 index 00000000..51dbc361 --- /dev/null +++ b/docs/guides/tools/detekt.md @@ -0,0 +1,5 @@ +--- +title: Detekt +sidebar_label: Detekt +description: CodeRabbit's guide to Detekt. +--- diff --git a/docs/guides/tools/gitleaks.md b/docs/guides/tools/gitleaks.md index dd0a242d..1e725b06 100644 --- a/docs/guides/tools/gitleaks.md +++ b/docs/guides/tools/gitleaks.md @@ -2,7 +2,6 @@ title: Gitleaks sidebar_label: Gitleaks description: CodeRabbit's guide to Gitleaks. -sidebar_position: 11 --- [Gitleaks](https://gitleaks.io/) is a secret-scanner. diff --git a/docs/guides/tools/golangci-lint.md b/docs/guides/tools/golangci-lint.md index 3f79ff25..541db7b9 100644 --- a/docs/guides/tools/golangci-lint.md +++ b/docs/guides/tools/golangci-lint.md @@ -2,7 +2,6 @@ title: golangci-lint sidebar_label: golangci-lint description: CodeRabbit's guide to golangci-lint. -sidebar_position: 9 --- [golangci-lint](https://golangci-lint.run/) is a fast Go linters runner. diff --git a/docs/guides/tools/hadolint.md b/docs/guides/tools/hadolint.md index e1859098..044a561d 100644 --- a/docs/guides/tools/hadolint.md +++ b/docs/guides/tools/hadolint.md @@ -2,7 +2,6 @@ title: Hadolint sidebar_label: Hadolint description: CodeRabbit's guide to Hadolint. -sidebar_position: 6 --- [Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter. diff --git a/docs/guides/tools/languagetool.md b/docs/guides/tools/languagetool.md index 4203239d..8ef4a59f 100644 --- a/docs/guides/tools/languagetool.md +++ b/docs/guides/tools/languagetool.md @@ -2,7 +2,6 @@ title: LanguageTool sidebar_label: LanguageTool description: CodeRabbit's guide to LanguageTool. -sidebar_position: 4 --- [LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker. diff --git a/docs/guides/tools/markdownlint.md b/docs/guides/tools/markdownlint.md index ef6573d0..14f3c0c8 100644 --- a/docs/guides/tools/markdownlint.md +++ b/docs/guides/tools/markdownlint.md @@ -2,7 +2,6 @@ title: Markdownlint sidebar_label: Markdownlint description: CodeRabbit's guide to Markdownlint. -sidebar_position: 3 --- [Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown. diff --git a/docs/guides/tools/phpstan.md b/docs/guides/tools/phpstan.md index 08567df9..a756f4c4 100644 --- a/docs/guides/tools/phpstan.md +++ b/docs/guides/tools/phpstan.md @@ -2,7 +2,6 @@ title: PHPStan sidebar_label: PHPStan description: CodeRabbit's guide to PHPStan. -sidebar_position: 8 --- [PHPStan](https://phpstan.org/) is a static analysis tool for PHP. diff --git a/docs/guides/tools/ruff.md b/docs/guides/tools/ruff.md index 5b400dda..a94bdec8 100644 --- a/docs/guides/tools/ruff.md +++ b/docs/guides/tools/ruff.md @@ -2,7 +2,6 @@ title: Ruff sidebar_label: Ruff description: CodeRabbit's guide to Ruff. -sidebar_position: 2 --- [Ruff](https://docs.astral.sh/ruff/) is a linter for Python. diff --git a/docs/guides/tools/shellcheck.md b/docs/guides/tools/shellcheck.md index cf476736..752e8675 100644 --- a/docs/guides/tools/shellcheck.md +++ b/docs/guides/tools/shellcheck.md @@ -2,7 +2,6 @@ title: ShellCheck sidebar_label: ShellCheck description: CodeRabbit's guide to ShellCheck. -sidebar_position: 1 --- [ShellCheck](https://www.shellcheck.net/) is a linter for shell scripts. diff --git a/docs/guides/tools/swiftlint.md b/docs/guides/tools/swiftlint.md index ee32bbcd..4c7c0ad8 100644 --- a/docs/guides/tools/swiftlint.md +++ b/docs/guides/tools/swiftlint.md @@ -2,7 +2,6 @@ title: SwiftLint sidebar_label: SwiftLint description: CodeRabbit's guide to SwiftLint. -sidebar_position: 7 --- [SwiftLint](https://realm.github.io/SwiftLint/) is a linter for Swift. diff --git a/docs/guides/tools/tools.md b/docs/guides/tools/tools.md index 1067be7f..cb3e29f5 100644 --- a/docs/guides/tools/tools.md +++ b/docs/guides/tools/tools.md @@ -36,25 +36,29 @@ Remove extraneous f prefix ## Supported Tools -| 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] | +| Technology | Tools | +|:----------------------------|:-----------------------------------------------------------| +| All | [Gitleaks][Gitleaks] | +| CloudFormation | [Checkov][Checkov] | +| CSS | [Biome][Biome] | +| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | +| Go | [golangci-lint][golangci-lint] | +| Helm | [Checkov][Checkov] | +| Javascript | [Biome][Biome] | +| JSON, JSONC | [Biome][Biome] | +| JSX | [Biome][Biome] | +| Kotlin | [Detekt][Detekt] | +| Kubernetes | [Checkov][Checkov] | +| Markdown | [Markdownlint][Markdownlint], [LanguageTool][LanguageTool] | +| PHP | [PHPStan][PHPStan] | +| Plaintext | [LanguageTool][LanguageTool] | +| Python | [Ruff][Ruff] | +| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | +| Swift | [SwiftLint][SwiftLint] | +| Terraform | [Checkov][Checkov] | +| TSX | [Biome][Biome] | +| Typescript | [Biome][Biome] | +| YAML | [YamlLint][YamlLint] | [ShellCheck]: ./shellcheck.md [Ruff]: ./ruff.md @@ -68,3 +72,4 @@ Remove extraneous f prefix [YamlLint]: ./yamllint.md [Gitleaks]: ./gitleaks.md [Checkov]: ./checkov.md +[Detekt]: ./detekt.md diff --git a/docs/guides/tools/yamllint.md b/docs/guides/tools/yamllint.md index e71542f3..8b4a9dda 100644 --- a/docs/guides/tools/yamllint.md +++ b/docs/guides/tools/yamllint.md @@ -2,7 +2,6 @@ title: Yamllint sidebar_label: Yamllint description: CodeRabbit's guide to Yamllint. -sidebar_position: 10 --- [Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML. From 24a28254cb3a5516308275ed496a4236836c4e05 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Tue, 16 Jul 2024 14:07:35 -0700 Subject: [PATCH 3/3] Update tool configuration documentation --- docs/guides/tools/tools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/tools/tools.md b/docs/guides/tools/tools.md index cb3e29f5..b7b85c1b 100644 --- a/docs/guides/tools/tools.md +++ b/docs/guides/tools/tools.md @@ -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 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. +Apart from the overall profile, you can also configure each tool by providing a path to 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. ## Checking Tool Output