This repository was archived by the owner on Aug 16, 2025. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork69
Add linter documentation#59
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
13 commits Select commitHold shift + click to select a range
455af2a Add linter documentation
hasitba319c5 docs: Move linter documentation to tools folder
hasit1d04172 Add more tools
hasit191e19e Add LanguageTool documentation and configuration
hasit2303cd0 Update Biome documentation and configuration
hasit78159d2 docs: Update linter documentation and configuration
hasit0b59424 chore: Update tools category label in _category_.yml
hasit0fda09b chore: Update tools category label and add new tools
hasit27c6bb1 docs: Fix typo in Biome linter documentation
hasit23acf22 chore: Add SwiftLint documentation and configuration
hasitba5b505 Add golangci-lint, PHPStan, and SwiftLint documentation and configura…
hasit9d01dfe Add Yamllint documentation and configuration
hasit9276d99 Add Checkov and Gitleaks documentation and configuration
hasitFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
2 changes: 1 addition & 1 deletiondocs/guides/commands.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletiondocs/guides/delete-account.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletionsdocs/guides/ondemand-reports.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletiondocs/guides/review-instructions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletionsdocs/guides/tools/_category_.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| label: Tools | ||
| position: 2 | ||
| collapsible: true | ||
| collapsed: true |
198 changes: 198 additions & 0 deletionsdocs/guides/tools/biome.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| --- | ||
| title: Biome | ||
| sidebar_label: Biome | ||
| description: CodeRabbit's guide to Biome. | ||
| sidebar_position: 5 | ||
| --- | ||
| [Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS. | ||
| ## Files | ||
| Biome will run on files with the following extensions: | ||
| - `.js` | ||
| - `.ts` | ||
| - `.cjs` | ||
| - `.mjs` | ||
| - `.d.cts` | ||
| - `.d.mts` | ||
| - `.jsx` | ||
| - `.tsx` | ||
| - `.json` | ||
| - `.jsonc` | ||
| - `.css` | ||
| ## Configuration | ||
| Biome supports the following config files: | ||
| - `biome.jsonc` | ||
| - `biome.json` | ||
| CodeRabbit will use the following settings based on the profile selected if no config file is found: | ||
| ### Chill | ||
| ```json | ||
| { | ||
| "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json", | ||
| "organizeImports": { | ||
| "enabled": false | ||
| }, | ||
| "formatter": { | ||
| "enabled": false | ||
| }, | ||
| "linter": { | ||
| "enabled": true, | ||
| "rules": { | ||
| "all": false, | ||
| "recommended": true, | ||
| "a11y": { | ||
| "recommended": false | ||
| }, | ||
| "correctness": { | ||
| "useExhaustiveDependencies": "off", | ||
| "noInnerDeclarations": "off" | ||
| }, | ||
| "style": { | ||
| "recommended": false, | ||
| "noArguments": "warn", | ||
| "noCommaOperator": "warn", | ||
| "noUselessElse": "warn", | ||
| "useAsConstAssertion": "off", | ||
| "useBlockStatements": "off", | ||
| "useConsistentArrayType": "off", | ||
| "useDefaultParameterLast": "warn", | ||
| "useEnumInitializers": "off", | ||
| "useExponentiationOperator": "warn", | ||
| "useExportType": "off", | ||
| "useFragmentSyntax": "off", | ||
| "useImportType": "off", | ||
| "useLiteralEnumMembers": "warn", | ||
| "useShorthandArrayType": "off", | ||
| "noUnusedTemplateLiteral": "off" | ||
| }, | ||
| "complexity": { | ||
| "noForEach": "off", | ||
| "noExcessiveCognitiveComplexity": { | ||
| "level": "off", | ||
| "options": { | ||
| "maxAllowedComplexity": 25 | ||
| } | ||
| }, | ||
| "useLiteralKeys": "off", | ||
| "useArrowFunction": "off", | ||
| "useFlatMap": "off" | ||
| }, | ||
| "suspicious": { | ||
| "noArrayIndexKey": "off", | ||
| "noExplicitAny": "off", | ||
| "noImplicitAnyLet": "off", | ||
| "noDoubleEquals": "off" | ||
| }, | ||
| "nursery": { | ||
| "all": false | ||
| } | ||
| } | ||
| }, | ||
| "css": { | ||
| "linter": { | ||
| "enabled": true | ||
| }, | ||
| "parser": { | ||
| "cssModules": true | ||
| } | ||
| }, | ||
| "javascript": { | ||
| "parser": { | ||
| "unsafeParameterDecoratorsEnabled": true | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ### Assertive | ||
| ```json | ||
| { | ||
| "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json", | ||
| "organizeImports": { | ||
| "enabled": false | ||
| }, | ||
| "formatter": { | ||
| "enabled": false | ||
| }, | ||
| "linter": { | ||
| "enabled": true, | ||
| "rules": { | ||
| "all": false, | ||
| "recommended": true, | ||
| "a11y": { | ||
| "recommended": "" | ||
| }, | ||
| "correctness": { | ||
| "useExhaustiveDependencies": "off", | ||
| "noInnerDeclarations": "warn" | ||
| }, | ||
| "style": { | ||
| "recommended": true, | ||
| "noArguments": "warn", | ||
| "noCommaOperator": "warn", | ||
| "noUselessElse": "warn", | ||
| "useAsConstAssertion": "off", | ||
| "useBlockStatements": "off", | ||
| "useConsistentArrayType": "off", | ||
| "useDefaultParameterLast": "warn", | ||
| "useEnumInitializers": "off", | ||
| "useExponentiationOperator": "warn", | ||
| "useExportType": "off", | ||
| "useFragmentSyntax": "off", | ||
| "useImportType": "off", | ||
| "useLiteralEnumMembers": "warn", | ||
| "useShorthandArrayType": "off", | ||
| "noUnusedTemplateLiteral": "off" | ||
| }, | ||
| "complexity": { | ||
| "noForEach": "off", | ||
| "noExcessiveCognitiveComplexity": { | ||
| "level": "warn", | ||
| "options": { | ||
| "maxAllowedComplexity": 25 | ||
| } | ||
| }, | ||
| "useLiteralKeys": "off", | ||
| "useArrowFunction": "", | ||
| "useFlatMap": "" | ||
| }, | ||
| "suspicious": { | ||
| "noArrayIndexKey": "", | ||
| "noExplicitAny": "", | ||
| "noImplicitAnyLet": "", | ||
| "noDoubleEquals": "" | ||
| }, | ||
| "nursery": { | ||
| "all": false | ||
| } | ||
| } | ||
| }, | ||
| "css": { | ||
| "linter": { | ||
| "enabled": true | ||
| }, | ||
| "parser": { | ||
| "cssModules": true | ||
| } | ||
| }, | ||
| "javascript": { | ||
| "parser": { | ||
| "unsafeParameterDecoratorsEnabled": true | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ## Links | ||
| - [Biome Configuration](https://biomejs.dev/reference/configuration/) |
63 changes: 63 additions & 0 deletionsdocs/guides/tools/checkov.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: Checkov | ||
| sidebar_label: Checkov | ||
| description: CodeRabbit's guide to Checkov. | ||
| sidebar_position: 2 | ||
| --- | ||
| [Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations. | ||
| ## Files | ||
| Checkov will run on files with the following files and extensions: | ||
| - `.tf` | ||
| - `.yml` | ||
| - `.yaml` | ||
| - `.json` | ||
| - `.template` | ||
| - `.bicep` | ||
| - `.hcl` | ||
| - `bower.json` | ||
| - `build.gradle` | ||
| - `build.gradle.kts` | ||
| - `go.sum` | ||
| - `gradle.properties` | ||
| - `METADATA` | ||
| - `npm-shrinkwrap.json` | ||
| - `package.json` | ||
| - `package-lock.json` | ||
| - `pom.xml` | ||
| - `requirements.txt` | ||
| - `Dockerfile` | ||
| - `.dockerfile` | ||
| - `Dockerfile.*` | ||
| - `.csproj` | ||
| - `yarn.lock` | ||
| - `Gemfile` | ||
| - `Gemfile.lock` | ||
| - `go.mod` | ||
| - `paket.dependencies` | ||
| - `paket.lock` | ||
| - `packages.config` | ||
| - `composer.json` | ||
| - `composer.lock` | ||
| ## Configuration | ||
| CodeRabbit will include on the following severity levels based on the profile selected: | ||
| ### Chill | ||
| - `HIGH` | ||
| - `CRITICAL` | ||
| ### Assertive | ||
| - `MEDIUM` | ||
| - `HIGH` | ||
| - `CRITICAL` | ||
| ## Links | ||
| - [Checkov All Resource Scans](https://www.checkov.io/5.Policy%20Index/all.html) |
22 changes: 22 additions & 0 deletionsdocs/guides/tools/gitleaks.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Gitleaks | ||
| sidebar_label: Gitleaks | ||
| description: CodeRabbit's guide to Gitleaks. | ||
| sidebar_position: 11 | ||
| --- | ||
| [Gitleaks](https://gitleaks.io/) is a secret-scanner. | ||
| ## Files | ||
| Gitleaks will run on all files with the following extensions. | ||
| ## Configuration | ||
| Gitleaks supports the following config files: | ||
| - `gitleaks.toml` | ||
| ## Links | ||
| - [Gitleaks Configuration](https://github.com/gitleaks/gitleaks#configuration) |
29 changes: 29 additions & 0 deletionsdocs/guides/tools/golangci-lint.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: golangci-lint | ||
| sidebar_label: golangci-lint | ||
| description: CodeRabbit's guide to golangci-lint. | ||
| sidebar_position: 9 | ||
| --- | ||
| [golangci-lint](https://golangci-lint.run/) is a fast Go linters runner. | ||
| ## Files | ||
| golangci-lint will run on files with the following extensions: | ||
| - `.go` | ||
| - `go.mod` | ||
| ## Configuration | ||
| golangci-lint supports the following config files: | ||
| - User-defined config file set at `reviews.tools.golangci-lint.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → golangci-lint → Config File" field in CodeRabbit's settings page. | ||
| - `.golangci.yml` | ||
| - `.golangci.yaml` | ||
| - `.golangci.toml` | ||
| - `.golangci.json` | ||
| ## Links | ||
| - [golangci-lint Configuration](https://golangci-lint.run/usage/configuration/) |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.