8000 feat: added docs for detekt and eslint · coderabbitai/coderabbit-docs@c688486 · GitHub
[go: up one dir, main page]
Skip to content

Commit c688486

Browse files
cr-ruhanmuzaffarcr-ruhanmuzaffar
committed
feat: added docs for detekt and eslint
1 parent 90d7c1c commit c688486

File tree

3 files changed

+59
-4
lines changed

3 files changed

+59
-4
lines changed

‎docs/guides/tools/detekt.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,27 @@ 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+
17+
## Configuration
18+
19+
Detekt uses a YAML style configuration file.
20+
21+
22+
Detekt supports the following config files:
23+
24+
- 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.
25+
26+
27+
## Links
28+
29+
- [Detekt Configuration](https://detekt.dev/docs/introduction/configurations/)

‎docs/guides/tools/eslint.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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+
19+
## Configuration
20+
21+
ESLint supports the following config files:
22+
23+
- `eslint.config.js`
24+
- `eslint.config.mjs`
25+
- `eslint.config.cjs`
26+
- `.eslintrc`
27+
28+
## Links
29+
30+
- [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)
0