Commit827d50b

authored

feat: added docs for detekt and eslint (#67)

* feat: added docs for detekt and eslint* fix: lint

1 parent90d7c1c commit827d50bCopy full SHA for 827d50b

File tree

+55

-4

lines changed

+55

-4

lines changed

Lines changed: 21 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,24 @@ title: Detekt`
`3`	`3`	`sidebar_label:Detekt`
`4`	`4`	`description:CodeRabbit's guide to Detekt.`
`5`	`5`	`---`
	`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/)`

Lines changed: 29 additions & 0 deletions

Original file line number	Diff line number	Diff 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)`

Lines changed: 5 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -44,9 +44,9 @@ Remove extraneous f prefix`
`44`	`44`	`\| Docker\|[Hadolint][Hadolint],[Checkov][Checkov]\|`
`45`	`45`	`\| Go\|[golangci-lint][golangci-lint]\|`
`46`	`46`	`\| Helm\|[Checkov][Checkov]\|`
`47`		`-\| Javascript\|[Biome][Biome]\|`
	`47`	`+\| Javascript\|[Biome][Biome],[ESLint][ESLint]\|`
`48`	`48`	`\| JSON, JSONC\|[Biome][Biome]\|`
`49`		`-\| JSX\|[Biome][Biome]\|`
	`49`	`+\| JSX\|[Biome][Biome],[ESLint][ESLint]\|`
`50`	`50`	`\| Kotlin\|[Detekt][Detekt]\|`
`51`	`51`	`\| Kubernetes\|[Checkov][Checkov]\|`
`52`	`52`	`\| Markdown\|[Markdownlint][Markdownlint],[LanguageTool][LanguageTool]\|`
`@@ -56,8 +56,8 @@ Remove extraneous f prefix`
`56`	`56`	`\| Shell (sh, bash, ksh, dash)\|[ShellCheck][ShellCheck]\|`
`57`	`57`	`\| Swift\|[SwiftLint][SwiftLint]\|`
`58`	`58`	`\| Terraform\|[Checkov][Checkov]\|`
`59`		`-\| TSX\|[Biome][Biome]\|`
`60`		`-\| Typescript\|[Biome][Biome]\|`
	`59`	`+\| TSX\|[Biome][Biome],[ESLint][ESLint]\|`
	`60`	`+\| Typescript\|[Biome][Biome],[ESLint][ESLint]\|`
`61`	`61`	`\| YAML\|[YamlLint][YamlLint]\|`
`62`	`62`
`63`	`63`	`[ShellCheck]:./shellcheck.md`
`@@ -73,3 +73,4 @@ Remove extraneous f prefix`
`73`	`73`	`[Gitleaks]:./gitleaks.md`
`74`	`74`	`[Checkov]:./checkov.md`
`75`	`75`	`[Detekt]:./detekt.md`
	`76`	`+[ESLint]:./eslint.md`

Comments

(0)