Skip to content

feat: added docs for detekt and eslint #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 18, 2024
Merged

feat: added docs for detekt and eslint #67

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c688486
feat: added docs for detekt and eslint
cr-ruhanmuzaffar Jul 18, 2024
fa296e0
fix: lint
cr-ruhanmuzaffar Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/guides/tools/detekt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,27 @@ title: Detekt
sidebar_label: Detekt
description: CodeRabbit's guide to Detekt.
---

[Detekt](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects

## Files

Detekt will run on files with the following extensions:

- `.kt`
- `.kts`


## Configuration

Detekt uses a YAML style configuration file.


Detekt supports the following config files:

- 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.


## Links

- [Detekt Configuration](https://detekt.dev/docs/introduction/configurations/)
30 changes: 30 additions & 0 deletions docs/guides/tools/eslint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: ESLint
sidebar_label: ESLint
description: CodeRabbit's guide to ESLint.
---

[ESLint](https://eslint.org/) is a static code analysis tool for identifying problematic patterns found in JavaScript code.

## Files

ESLint will run on files with the following extensions:

- `.js`
- `.jsx`
- `.ts`
- `.tsx`


## Configuration

ESLint supports the following config files:

- `eslint.config.js`
- `eslint.config.mjs`
- `eslint.config.cjs`
- `.eslintrc`

## Links

- [ESLint Configuration](https://eslint.org/docs/latest/use/configure/configuration-files)
9 changes: 5 additions & 4 deletions docs/guides/tools/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ Remove extraneous f prefix
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] |
| Go | [golangci-lint][golangci-lint] |
| Helm | [Checkov][Checkov] |
| Javascript | [Biome][Biome] |
| Javascript | [Biome][Biome], [ESLint][ESLint] |
| JSON, JSONC | [Biome][Biome] |
| JSX | [Biome][Biome] |
| JSX | [Biome][Biome], [ESLint][ESLint] |
| Kotlin | [Detekt][Detekt] |
| Kubernetes | [Checkov][Checkov] |
| Markdown | [Markdownlint][Markdownlint], [LanguageTool][LanguageTool] |
Expand All @@ -56,8 +56,8 @@ Remove extraneous f prefix
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] |
| Swift | [SwiftLint][SwiftLint] |
| Terraform | [Checkov][Checkov] |
| TSX | [Biome][Biome] |
| Typescript | [Biome][Biome] |
| TSX | [Biome][Biome], [ESLint][ESLint] |
| Typescript | [Biome][Biome], [ESLint][ESLint] |
| YAML | [YamlLint][YamlLint] |

[ShellCheck]: ./shellcheck.md
Expand All @@ -73,3 +73,4 @@ Remove extraneous f prefix
[Gitleaks]: ./gitleaks.md
[Checkov]: ./checkov.md
[Detekt]: ./detekt.md
[ESLint]:./eslint.md