diff --git a/docs/guides/tools/detekt.md b/docs/guides/tools/detekt.md index 51dbc361..b3877a98 100644 --- a/docs/guides/tools/detekt.md +++ b/docs/guides/tools/detekt.md @@ -3,3 +3,24 @@ 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..121e2c60 --- /dev/null +++ b/docs/guides/tools/eslint.md @@ -0,0 +1,29 @@ +--- +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
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: