From c6884869a690e5537c6842158d57c2befb032d07 Mon Sep 17 00:00:00 2001 From: Ruhan Date: Thu, 18 Jul 2024 19:33:34 +0530 Subject: [PATCH 1/2] feat: added docs for detekt and eslint --- docs/guides/tools/detekt.md | 24 ++++++++++++++++++++++++ docs/guides/tools/eslint.md | 30 ++++++++++++++++++++++++++++++ docs/guides/tools/tools.md | 9 +++++---- 3 files changed, 59 insertions(+), 4 deletions(-) create mode 100644 docs/guides/tools/eslint.md diff --git a/docs/guides/tools/detekt.md b/docs/guides/tools/detekt.md index 51dbc361..d815c2b9 100644 --- a/docs/guides/tools/detekt.md +++ b/docs/guides/tools/detekt.md @@ -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/) diff --git a/docs/guides/tools/eslint.md b/docs/guides/tools/eslint.md new file mode 100644 index 00000000..cf39cccf --- /dev/null +++ b/docs/guides/tools/eslint.md @@ -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) diff --git a/docs/guides/tools/tools.md b/docs/guides/tools/tools.md index b7b85c1b..ef3ad2d0 100644 --- a/docs/guides/tools/tools.md +++ b/docs/guides/tools/tools.md @@ -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] | @@ -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 @@ -73,3 +73,4 @@ Remove extraneous f prefix [Gitleaks]: ./gitleaks.md [Checkov]: ./checkov.md [Detekt]: ./detekt.md +[ESLint]:./eslint.md From fa296e0c4c90f7418774ed2609c890acad71d5eb Mon Sep 17 00:00:00 2001 From: Ruhan Date: Thu, 18 Jul 2024 23:12:56 +0530 Subject: [PATCH 2/2] fix: lint --- docs/guides/tools/detekt.md | 5 +---- docs/guides/tools/eslint.md | 1 - 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/guides/tools/detekt.md b/docs/guides/tools/detekt.md index d815c2b9..b3877a98 100644 --- a/docs/guides/tools/detekt.md +++ b/docs/guides/tools/detekt.md @@ -13,17 +13,14 @@ Detekt will run on files with the following extensions: - `.kt` - `.kts` - ## Configuration -Detekt uses a YAML style configuration file. - +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/) diff --git a/docs/guides/tools/eslint.md b/docs/guides/tools/eslint.md index cf39cccf..121e2c60 100644 --- a/docs/guides/tools/eslint.md +++ b/docs/guides/tools/eslint.md @@ -15,7 +15,6 @@ ESLint will run on files with the following extensions: - `.ts` - `.tsx` - ## Configuration ESLint supports the following config files: pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy