Skip to content

Commit c92ba04

Browse files
harjotgillharjotgill
committed
tools: update names
1 parent 25a053e commit c92ba04

File tree

8 files changed

+55
-55
lines changed

8 files changed

+55
-55
lines changed

‎docs/changelog.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ You can now choose whether to auto-generate sequence diagrams in the PR Walkthro
186186

187187
We've refined the default settings to be less noisy and more actionable. Additionally, we've added new static analysis and security tools:
188188

189-
- **Yamllint**: A linter for YAML files
189+
- **YAMLlint**: A linter for YAML files
190190
- **Gitleaks**: A lightweight, open-source secret scanner to prevent security breaches
191191
- **Checkov**: Scans infrastructure as code for misconfigurations before they become security issues
192192

@@ -234,8 +234,8 @@ Users can now select between **Chill** and **Assertive** review tones to tailor
234234

235235
We are continually expanding our support for static analysis tools. We've recently added support for
236236

237-
- biome
238-
- hadolint
237+
- Biome
238+
- Hadolint
239239
- ast-grep.
240240

241241
Update your .coderabbit.yaml file or visit the settings page to enable or disable the tools you wish to use.

‎docs/tools/actionlint.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Actionlint
3-
sidebar_label: Actionlint
4-
description: CodeRabbit's guide to Actionlint.
2+
title: actionlint
3+
sidebar_label: actionlint
4+
description: CodeRabbit's guide to actionlint.
55
---
66

77
```mdx-code-block
@@ -10,7 +10,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

13-
[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for
13+
[`actionlint`](https://github.com/rhysd/actionlint/) is a static checker for
1414
GitHub Actions workflow files.
1515

1616
## Files
@@ -26,4 +26,4 @@ CodeRabbit will use the default configuration.
2626

2727
## Links
2828

29-
- [Actionlint Configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md/)
29+
- [`actionlint` Configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md/)

‎docs/tools/circleci.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: CircleCi
3-
sidebar_label: CircleCi
4-
description: CodeRabbit's guide to CircleCi.
2+
title: CircleCI
3+
sidebar_label: CircleCI
4+
description: CodeRabbit's guide to CircleCI.
55
---
66

77
```mdx-code-block
@@ -10,11 +10,11 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

13-
[CircleCi](https://circleci.com/) is a static checker and validator for circleci config files.
13+
[CircleCI](https://circleci.com/) is a static checker and validator for circleci config files.
1414

1515
## Files
1616

17-
We look for `CircleCi Configuration` files specifically in the following directory:
17+
We look for `CircleCI Configuration` files specifically in the following directory:
1818

1919
- `.circleci/config.yml`
2020
- `.circleci/config.yaml`
@@ -25,4 +25,4 @@ CodeRabbit will use the default configuration.
2525

2626
## Links
2727

28-
- [CircleCi Configuration](https://circleci.com/docs/configuration-reference/)
28+
- [CircleCI Configuration](https://circleci.com/docs/configuration-reference/)

‎docs/tools/detekt.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Detekt
3-
sidebar_label: Detekt
4-
description: CodeRabbit's guide to Detekt.
2+
title: detekt
3+
sidebar_label: detekt
4+
description: CodeRabbit's guide to detekt.
55
---
66

77
```mdx-code-block
@@ -10,23 +10,23 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

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

1515
## Files
1616

17-
Detekt will run on files with the following extensions:
17+
`detekt` will run on files with the following extensions:
1818

1919
- `.kt`
2020
- `.kts`
2121

2222
## Configuration
2323

24-
Detekt uses a YAML style configuration file.
24+
`detekt` uses a YAML style configuration file.
2525

26-
Detekt supports the following config files:
26+
`detekt` supports the following config files:
2727

28-
- 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.
28+
- 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.
2929

3030
## Links
3131

32-
- [Detekt Configuration](https://detekt.dev/docs/introduction/configurations/)
32+
- [`detekt` Configuration](https://detekt.dev/docs/introduction/configurations/)

‎docs/tools/markdownlint.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Markdownlint
3-
sidebar_label: Markdownlint
4-
description: CodeRabbit's guide to Markdownlint.
2+
title: markdownlint
3+
sidebar_label: markdownlint
4+
description: CodeRabbit's guide to markdownlint.
55
---
66

77
```mdx-code-block
@@ -10,7 +10,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

13-
[Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown.
13+
[`markdownlint-cli2`](https://github.com/DavidAnson/markdownlint) is a linter for Markdown.
1414

1515
## Files
1616

@@ -21,7 +21,7 @@ Markdownlint will run on files with the following extensions:
2121

2222
## Configuration
2323

24-
Markdownlint supports the following config files:
24+
`markdownlint-cli2` supports the following config files:
2525

2626
- `.markdownlint.jsonc`
2727
- `.markdownlint.json`
@@ -32,4 +32,4 @@ CodeRabbit will use the default settings based on the profile selected if no con
3232

3333
## Links
3434

35-
- [Markdownlint Configuration](https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#configuration)
35+
- [`markdownlint-cli2` Configuration](https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#configuration)

‎docs/tools/rubocop.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Rubocop
3-
sidebar_label: Rubocop
4-
description: CodeRabbit's guide to Rubocop.
2+
title: RuboCop
3+
sidebar_label: RuboCop
4+
description: CodeRabbit's guide to RuboCop.
55
---
66

77
```mdx-code-block
@@ -10,11 +10,11 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

13-
[Rubocop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide.
13+
[RuboCop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide.
1414

1515
## Files
1616

17-
Rubocop will run on the following files and extensions:
17+
RuboCop will run on the following files and extensions:
1818

1919
- `.rb`
2020
- `.arb`
@@ -72,7 +72,7 @@ Rubocop will run on the following files and extensions:
7272

7373
## Configuration
7474

75-
Rubocop uses a YAML style configuration file. We look for the following files anywhere in the repository:
75+
RuboCop uses a YAML style configuration file. We look for the following files anywhere in the repository:
7676

7777
- `.rubocop.yml`
7878
- `.rubocop.yaml`
@@ -81,4 +81,4 @@ CodeRabbit will use the default settings based on the profile selected if no con
8181

8282
## Links
8383

84-
- [Rubocop Configuration](https://docs.rubocop.org/rubocop/1.65/configuration.html/)
84+
- [RuboCop Configuration](https://docs.rubocop.org/rubocop/1.65/configuration.html/)

‎docs/tools/tools.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -45,53 +45,53 @@ Remove extraneous f prefix
4545
| Technology | Tools | Category |
4646
| :-------------------------- | :--------------------------------------------------------- | :----------------------------- |
4747
| All | [Gitleaks][Gitleaks] | Code Security |
48-
| CircleCi | [CircleCi][CircleCi] | Configuration Validation |
48+
| CircleCI | [CircleCI][CircleCI] | Configuration Validation |
4949
| CloudFormation | [Checkov][Checkov] | Code Security |
5050
| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
5151
| CSS | [Biome][Biome] | Code Quality |
5252
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
53-
| GitHub Actions | [Actionlint][Actionlint] | Code Quality |
53+
| GitHub Actions | [actionlint][actionlint] | Code Quality |
5454
| Go | [golangci-lint][golangci-lint] | Code Quality |
5555
| Helm | [Checkov][Checkov] | Code Security |
5656
| Javascript | [Biome][Biome] | Code Quality |
5757
| JSON, JSONC | [Biome][Biome] | Code Quality |
5858
| JSX | [Biome][Biome] | Code Quality |
59-
| Kotlin | [Detekt][Detekt] | Code Quality |
59+
| Kotlin | [detekt][detekt] | Code Quality |
6060
| Kubernetes | [Checkov][Checkov] | Code Security |
61-
| Markdown | [Markdownlint][Markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
61+
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
6262
| PHP | [PHPStan][PHPStan] | Code Quality |
6363
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
6464
| Java | [PMD][PMD] | Code Quality |
6565
| Protobuf | [Buf][Buf] | Code Quality |
6666
| Python | [Ruff][Ruff] | Code Quality |
6767
| Regal | [Regal][Regal] | Code Quality |
68-
| Ruby | [Rubocop][Rubocop] | Code Quality |
68+
| Ruby | [RuboCop][RuboCop] | Code Quality |
6969
| Semgrep | [Semgrep][Semgrep] | Code Security |
7070
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
7171
| Swift | [SwiftLint][SwiftLint] | Code Quality |
7272
| Terraform | [Checkov][Checkov] | Code Security |
7373
| TSX | [Biome][Biome] | Code Quality |
7474
| Typescript | [Biome][Biome] | Code Quality |
75-
| YAML | [YamlLint][YamlLint] | Code Quality |
75+
| YAML | [YAMLlint][YAMLlint] | Code Quality |
7676

7777
[ShellCheck]: ./shellcheck.md
7878
[Ruff]: ./ruff.md
79-
[Markdownlint]: ./markdownlint.md
79+
[markdownlint]: ./markdownlint.md
8080
[LanguageTool]: ./languagetool.md
8181
[Biome]: ./biome.md
8282
[Hadolint]: ./hadolint.md
8383
[SwiftLint]: ./swiftlint.md
8484
[PHPStan]: ./phpstan.md
8585
[golangci-lint]: ./golangci-lint.md
86-
[YamlLint]: ./yamllint.md
86+
[YAMLlint]: ./yamllint.md
8787
[Gitleaks]: ./gitleaks.md
8888
[Checkov]: ./checkov.md
89-
[Detekt]: ./detekt.md
90-
[Rubocop]: ./rubocop.md
89+
[detekt]: ./detekt.md
90+
[RuboCop]: ./rubocop.md
9191
[Buf]: ./buf.md
92-
[Actionlint]: ./actionlint.md
92+
[actionlint]: ./actionlint.md
9393
[Regal]: ./regal.md
9494
[PMD]: ./pmd.md
9595
[Cppcheck]: ./cppcheck.md
96-
[CircleCi]: ./circleci.md
96+
[CircleCI]: ./circleci.md
9797
[Semgrep]: ./semgrep.md

‎docs/tools/yamllint.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Yamllint
3-
sidebar_label: Yamllint
4-
description: CodeRabbit's guide to Yamllint.
2+
title: YAMLlint
3+
sidebar_label: YAMLlint
4+
description: CodeRabbit's guide to YAMLlint.
55
---
66

77
```mdx-code-block
@@ -10,18 +10,18 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

13-
[Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.
13+
[YAMLlint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.
1414

1515
## Files
1616

17-
Yamllint will run on files with the following extensions:
17+
YAMLlint will run on files with the following extensions:
1818

1919
- `.yaml`
2020
- `.yml`
2121

2222
## Configuration
2323

24-
Yamllint supports the following config files:
24+
YAMLlint supports the following config files:
2525

2626
- `.yamllint`
2727
- `.yamllint.yaml`
@@ -31,4 +31,4 @@ CodeRabbit will use the default settings based on the profile selected if no con
3131

3232
## Links
3333

34-
- [Yamllint Configuration](https://yamllint.readthedocs.io/en/stable/configuration.html)
34+
- [YAMLlint Configuration](https://yamllint.readthedocs.io/en/stable/configuration.html)

0 commit comments

Comments
 (0)