Skip to content

Commit 44372e7

Browse files
hasithasit
committed
Update supported tools table and documentation
1 parent ce6e11a commit 44372e7

14 files changed

+29
-31
lines changed

‎docs/guides/tools/biome.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Biome
33
sidebar_label: Biome
44
description: CodeRabbit's guide to Biome.
5-
sidebar_position: 5
65
---
76

87
[Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS.

‎docs/guides/tools/checkov.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Checkov
33
sidebar_label: Checkov
44
description: CodeRabbit's guide to Checkov.
5-
sidebar_position: 2
65
---
76

87
[Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations.

‎docs/guides/tools/detekt.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Detekt
3+
sidebar_label: Detekt
4+
description: CodeRabbit's guide to Detekt.
5+
---

‎docs/guides/tools/gitleaks.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Gitleaks
33
sidebar_label: Gitleaks
44
description: CodeRabbit's guide to Gitleaks.
5-
sidebar_position: 11
65
---
76

87
[Gitleaks](https://gitleaks.io/) is a secret-scanner.

‎docs/guides/tools/golangci-lint.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: golangci-lint
33
sidebar_label: golangci-lint
44
description: CodeRabbit's guide to golangci-lint.
5-
sidebar_position: 9
65
---
76

87
[golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.

‎docs/guides/tools/hadolint.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Hadolint
33
sidebar_label: Hadolint
44
description: CodeRabbit's guide to Hadolint.
5-
sidebar_position: 6
65
---
76

87
[Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter.

‎docs/guides/tools/languagetool.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: LanguageTool
33
sidebar_label: LanguageTool
44
description: CodeRabbit's guide to LanguageTool.
5-
sidebar_position: 4
65
---
76

87
[LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker.

‎docs/guides/tools/markdownlint.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Markdownlint
33
sidebar_label: Markdownlint
44
description: CodeRabbit's guide to Markdownlint.
5-
sidebar_position: 3
65
---
76

87
[Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown.

‎docs/guides/tools/phpstan.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: PHPStan
33
sidebar_label: PHPStan
44
description: CodeRabbit's guide to PHPStan.
5-
sidebar_position: 8
65
---
76

87
[PHPStan](https://phpstan.org/) is a static analysis tool for PHP.

‎docs/guides/tools/ruff.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Ruff
33
sidebar_label: Ruff
44
description: CodeRabbit's guide to Ruff.
5-
sidebar_position: 2
65
---
76

87
[Ruff](https://docs.astral.sh/ruff/) is a linter for Python.

‎docs/guides/tools/shellcheck.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: ShellCheck
33
sidebar_label: ShellCheck
44
description: CodeRabbit's guide to ShellCheck.
5-
sidebar_position: 1
65
---
76

87
[ShellCheck](https://www.shellcheck.net/) is a linter for shell scripts.

‎docs/guides/tools/swiftlint.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: SwiftLint
33
sidebar_label: SwiftLint
44
description: CodeRabbit's guide to SwiftLint.
5-
sidebar_position: 7
65
---
76

87
[SwiftLint](https://realm.github.io/SwiftLint/) is a linter for Swift.

‎docs/guides/tools/tools.md

+24-19
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,29 @@ Remove extraneous f prefix
3636

3737
## Supported Tools
3838

39-
| Language | Tool |
40-
|----------------|----------------|
41-
| All | [Gitleaks][Gitleaks] |
42-
| Text | [LanguageTool][LanguageTool] |
43-
| Bash | [ShellCheck][ShellCheck] |
44-
| Python | [Ruff][Ruff] |
45-
| Markdown | [Markdownlint][Markdownlint], [LanguageTool][LanguageTool] |
46-
| Javascript | [Biome][[Biome]] |
47-
| Typescript | [Biome][[Biome]] |
48-
| JSX | [Biome][[Biome]] |
49-
| TSX | [Biome][[Biome]] |
50-
| CSS | [Biome][[Biome]] |
51-
| JSON, JSONC | [Biome][Biome] |
52-
| Docker | [Hadolint][Hadolint] |
53-
| Swift | [SwiftLint][SwiftLint] |
54-
| PHP | [PHPStan][PHPStan] |
55-
| Go | [golangci-lint][golangci-lint] |
56-
| YAML | [YamlLint][YamlLint] |
57-
| Infrastructure as Code (IaC) | [Checkov][Checkov] |
39+
| Technology | Tools |
40+
|:----------------------------|:-----------------------------------------------------------|
41+
| All | [Gitleaks][Gitleaks] |
42+
| CloudFormation | [Checkov][Checkov] |
43+
| CSS | [Biome][Biome] |
44+
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] |
45+
| Go | [golangci-lint][golangci-lint] |
46+
| Helm | [Checkov][Checkov] |
47+
| Javascript | [Biome][Biome] |
48+
| JSON, JSONC | [Biome][Biome] |
49+
| JSX | [Biome][Biome] |
50+
| Kotlin | [Detekt][Detekt] |
51+
| Kubernetes | [Checkov][Checkov] |
52+
| Markdown | [Markdownlint][Markdownlint], [LanguageTool][LanguageTool] |
53+
| PHP | [PHPStan][PHPStan] |
54+
| Plaintext | [LanguageTool][LanguageTool] |
55+
| Python | [Ruff][Ruff] |
56+
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] |
57+
| Swift | [SwiftLint][SwiftLint] |
58+
| Terraform | [Checkov][Checkov] |
59+
| TSX | [Biome][Biome] |
60+
| Typescript | [Biome][Biome] |
61+
| YAML | [YamlLint][YamlLint] |
5862

5963
[ShellCheck]: ./shellcheck.md
6064
[Ruff]: ./ruff.md
@@ -68,3 +72,4 @@ Remove extraneous f prefix
6872
[YamlLint]: ./yamllint.md
6973
[Gitleaks]: ./gitleaks.md
7074
[Checkov]: ./checkov.md
75+
[Detekt]: ./detekt.md

‎docs/guides/tools/yamllint.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Yamllint
33
sidebar_label: Yamllint
44
description: CodeRabbit's guide to Yamllint.
5-
sidebar_position: 10
65
---
76

87
[Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.

0 commit comments

Comments
 (0)