Add table for Supported Tools by languages (#63)

hasit · web-flow · commit 00de52eb98a0 · 2024-07-16T14:09:06.000-07:00
* Add table for Supported Tools by languages

* Update supported tools table and documentation

* Update tool configuration documentation
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 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
 
@@ -36,15 +36,40 @@ 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)
+| 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
+[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
diff --git 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.
