Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Commit 827d50b

Browse files
feat: added docs for detekt and eslint (#67)
* feat: added docs for detekt and eslint * fix: lint
1 parent 90d7c1c commit 827d50b

File tree

3 files changed

+55
-4
lines changed

3 files changed

+55
-4
lines changed

‎docs/guides/tools/detekt.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,24 @@ title: Detekt
33
sidebar_label: Detekt
44
description: CodeRabbit's guide to Detekt.
55
---
6+
7+
[Detekt](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects
8+
9+
## Files
10+
11+
Detekt will run on files with the following extensions:
12+
13+
-`.kt`
14+
-`.kts`
15+
16+
## Configuration
17+
18+
Detekt uses a YAML style configuration file.
19+
20+
Detekt supports the following config files:
21+
22+
- User-defined config file set at `reviews.tools.detekt.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → Detekt → Config File" field in CodeRabbit's settings page.
23+
24+
## Links
25+
26+
-[Detekt Configuration](https://detekt.dev/docs/introduction/configurations/)

‎docs/guides/tools/eslint.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: ESLint
3+
sidebar_label: ESLint
4+
description: CodeRabbit's guide to ESLint.
5+
---
6+
7+
[ESLint](https://eslint.org/) is a static code analysis tool for identifying problematic patterns found in JavaScript code.
8+
9+
## Files
10+
11+
ESLint will run on files with the following extensions:
12+
13+
-`.js`
14+
-`.jsx`
15+
-`.ts`
16+
-`.tsx`
17+
18+
## Configuration
19+
20+
ESLint supports the following config files:
21+
22+
-`eslint.config.js`
23+
-`eslint.config.mjs`
24+
-`eslint.config.cjs`
25+
-`.eslintrc`
26+
27+
## Links
28+
29+
-[ESLint Configuration](https://eslint.org/docs/latest/use/configure/configuration-files)

‎docs/guides/tools/tools.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Remove extraneous f prefix
4444
| Docker |[Hadolint][Hadolint], [Checkov][Checkov]|
4545
| Go |[golangci-lint][golangci-lint]|
4646
| Helm |[Checkov][Checkov]|
47-
| Javascript |[Biome][Biome]|
47+
| Javascript |[Biome][Biome], [ESLint][ESLint]|
4848
| JSON, JSONC |[Biome][Biome]|
49-
| JSX |[Biome][Biome]|
49+
| JSX |[Biome][Biome], [ESLint][ESLint]|
5050
| Kotlin |[Detekt][Detekt]|
5151
| Kubernetes |[Checkov][Checkov]|
5252
| Markdown |[Markdownlint][Markdownlint], [LanguageTool][LanguageTool]|
@@ -56,8 +56,8 @@ Remove extraneous f prefix
5656
| Shell (sh, bash, ksh, dash) |[ShellCheck][ShellCheck]|
5757
| Swift |[SwiftLint][SwiftLint]|
5858
| Terraform |[Checkov][Checkov]|
59-
| TSX |[Biome][Biome]|
60-
| Typescript |[Biome][Biome]|
59+
| TSX |[Biome][Biome], [ESLint][ESLint]|
60+
| Typescript |[Biome][Biome], [ESLint][ESLint]|
6161
| YAML |[YamlLint][YamlLint]|
6262

6363
[ShellCheck]: ./shellcheck.md
@@ -73,3 +73,4 @@ Remove extraneous f prefix
7373
[Gitleaks]: ./gitleaks.md
7474
[Checkov]: ./checkov.md
7575
[Detekt]: ./detekt.md
76+
[ESLint]:./eslint.md

0 commit comments

Comments
(0)