Skip to content

Commit c9e703b

Browse files
syedalinaqihasnisyedalinaqihasni
authored
Merge branch 'main' into feature/issue/160
2 parents f2a003e + b0fdbf0 commit c9e703b

File tree

6 files changed

+151
-65
lines changed

6 files changed

+151
-65
lines changed

‎docs/changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

8+
## May 19, 2025
9+
10+
### Lua Support with Luacheck
11+
12+
We're excited to announce enhanced support for Lua code analysis with [Luacheck](https://github.com/mpeterv/luacheck), a powerful static analyzer and linter for Lua code.
13+
814
## April 19, 2025
915

1016
### Docstring Path Instructions

‎docs/tools/list.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: List of supported tools
3+
description: Overview of CodeRabbit's supported linters and security analysis tools
4+
---
5+
6+
This is a list of the third-party open-source linters and security analysis tools that CodeRabbit uses to generate code reviews.
7+
8+
For more information about fine-tuning the CodeRabbit configuration of a tool, click that tool's name in the following list.
9+
10+
For an overview of how CodeRabbit uses these tools when generating code reviews, as well as general information about controlling their use, see [Configure third-party tools](/tools/).
11+
12+
| Technology | Tools | Category |
13+
| :-------------------------- | :--------------------------------------------------------- | :-------------------------------------------------- |
14+
| All | [Gitleaks][Gitleaks], [Pipeline Remediation][Pipeline] | Code Security, CI/CD |
15+
| Azure DevOps Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
16+
| CircleCI | [CircleCI][CircleCI], [Pipeline Remediation][Pipeline] | Configuration Validation, CI/CD Failure Remediation |
17+
| CloudFormation | [Checkov][Checkov] | Code Security |
18+
| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
19+
| CSS | [Biome][Biome] | Code Quality |
20+
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
21+
| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation |
22+
| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
23+
| Go | [golangci-lint][golangci-lint] | Code Quality |
24+
| Helm | [Checkov][Checkov] | Code Security |
25+
| Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
26+
| JSON, JSONC | [Biome][Biome] | Code Quality |
27+
| JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
28+
| Kotlin | [detekt][detekt] | Code Quality |
29+
| Kubernetes | [Checkov][Checkov] | Code Security |
30+
| Lua | [Luacheck][Luacheck] | Code Quality |
31+
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
32+
| PHP | [PHPStan][PHPStan] | Code Quality |
33+
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
34+
| Java | [PMD][PMD] | Code Quality |
35+
| Protobuf | [Buf][Buf] | Code Quality |
36+
| Python | [Ruff][Ruff] | Code Quality |
37+
| Regal | [Regal][Regal] | Code Quality |
38+
| Ruby | [RuboCop][RuboCop] | Code Quality |
39+
| Semgrep | [Semgrep][Semgrep] | Code Security |
40+
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
41+
| Shopify | [Shopify CLI][ShopifyCLI] | Code Quality |
42+
| SQL | [SQLFluff][SQLFluff] | Code Quality |
43+
| Swift | [SwiftLint][SwiftLint] | Code Quality |
44+
| Terraform | [Checkov][Checkov] | Code Security |
45+
| TSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
46+
| Typescript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
47+
| YAML | [YAMLlint][YAMLlint] | Code Quality |
48+
| Prisma | [Prisma Lint][PrismaLint] | Code Quality |
49+
50+
[ShellCheck]: /tools/shellcheck.md
51+
[SQLFluff]: /tools/sqlfluff.md
52+
[Ruff]: /tools/ruff.md
53+
[markdownlint]: /tools/markdownlint.md
54+
[LanguageTool]: /tools/languagetool.md
55+
[Biome]: /tools/biome.md
56+
[Hadolint]: /tools/hadolint.md
57+
[SwiftLint]: /tools/swiftlint.md
58+
[PHPStan]: /tools/phpstan.md
59+
[golangci-lint]: /tools/golangci-lint.md
60+
[YAMLlint]: /tools/yamllint.md
61+
[Gitleaks]: /tools/gitleaks.md
62+
[Checkov]: /tools/checkov.md
63+
[detekt]: /tools/detekt.md
64+
[RuboCop]: /tools/rubocop.md
65+
[Buf]: /tools/buf.md
66+
[actionlint]: /tools/actionlint.md
67+
[Regal]: /tools/regal.md
68+
[PMD]: /tools/pmd.md
69+
[Cppcheck]: /tools/cppcheck.md
70+
[CircleCI]: /tools/circleci.md
71+
[Semgrep]: /tools/semgrep.md
72+
[Pipeline]: /tools/pipeline-remediation.md
73+
[PrismaLint]: /tools/prisma-lint.md
74+
[oxlint]: /tools/oxlint.md
75+
[ShopifyCLI]: /tools/shopify-cli.md
76+
[Luacheck]: /tools/luacheck.md

‎docs/tools/luacheck.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Luacheck
3+
sidebar_label: Luacheck
4+
description: CodeRabbit's guide to Luacheck.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
[Luacheck](https://github.com/mpeterv/luacheck) is a static analyzer and linter for Lua code that detects various issues such as undefined global variables, unused variables and values, accessing uninitialized variables, unreachable code, and more.
14+
15+
## Supported Files
16+
17+
Luacheck will run on files with the following extensions:
18+
19+
- `.lua`
20+
21+
## Configuration
22+
23+
Luacheck supports the following configuration files:
24+
25+
- `.luacheckrc`
26+
- `luacheckrc`
27+
- `.luacheckrc.lua`
28+
- `luacheckrc.lua`
29+
30+
:::note
31+
32+
Luacheck does not require configuration to run. If no configuration file is found, it will use default settings.
33+
34+
:::
35+
36+
## Features
37+
38+
Luacheck can detect:
39+
40+
- Usage of undefined global variables
41+
- Unused variables and values
42+
- Accessing uninitialized variables
43+
- Unreachable code
44+
- And many more issues
45+
46+
## Links
47+
48+
- [Luacheck GitHub Repository](https://github.com/mpeterv/luacheck)
49+
- [Luacheck Documentation](https://luacheck.readthedocs.io/)

‎docs/tools/tools.md

Lines changed: 5 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Configure third-party tool use
33
description: Overview of CodeRabbit's supported linters and security analysis tools.
44
---
55

6+
This page provides an overview of how CodeRabbit uses third-party open-source tools to deliver its multifaceted code reviews. For a complete list of supported tools, see [Supported tools](/tools/list).
7+
68
```mdx-code-block
79
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
810
@@ -40,68 +42,6 @@ Remove extraneous f prefix
4042
(F541)
4143
```
4244

43-
## Supported Tools
44-
45-
| Technology | Tools | Category |
46-
| :-------------------------- | :--------------------------------------------------------- | :-------------------------------------------------- |
47-
| All | [Gitleaks][Gitleaks], [Pipeline Remediation][Pipeline] | Code Security, CI/CD |
48-
| Azure DevOps Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
49-
| CircleCI | [CircleCI][CircleCI], [Pipeline Remediation][Pipeline] | Configuration Validation, CI/CD Failure Remediation |
50-
| CloudFormation | [Checkov][Checkov] | Code Security |
51-
| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
52-
| CSS | [Biome][Biome] | Code Quality |
53-
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
54-
| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation |
55-
| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
56-
| Go | [golangci-lint][golangci-lint] | Code Quality |
57-
| Helm | [Checkov][Checkov] | Code Security |
58-
| Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
59-
| JSON, JSONC | [Biome][Biome] | Code Quality |
60-
| JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
61-
| Kotlin | [detekt][detekt] | Code Quality |
62-
| Kubernetes | [Checkov][Checkov] | Code Security |
63-
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
64-
| PHP | [PHPStan][PHPStan] | Code Quality |
65-
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
66-
| Java | [PMD][PMD] | Code Quality |
67-
| Protobuf | [Buf][Buf] | Code Quality |
68-
| Python | [Ruff][Ruff] | Code Quality |
69-
| Regal | [Regal][Regal] | Code Quality |
70-
| Ruby | [RuboCop][RuboCop] | Code Quality |
71-
| Semgrep | [Semgrep][Semgrep] | Code Security |
72-
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
73-
| Shopify | [Shopify CLI][ShopifyCLI] | Code Quality |
74-
| SQL | [SQLFluff][SQLFluff] | Code Quality |
75-
| Swift | [SwiftLint][SwiftLint] | Code Quality |
76-
| Terraform | [Checkov][Checkov] | Code Security |
77-
| TSX | [Biome][Biome], [oxlint][oxlint] | Code Quality |
78-
| Typescript | [Biome][Biome], [oxlint][oxlint] | Code Quality |
79-
| YAML | [YAMLlint][YAMLlint] | Code Quality |
80-
| Prisma | [Prisma Lint][PrismaLint] | Code Quality |
81-
82-
[ShellCheck]: ./shellcheck.md
83-
[SQLFluff]: ./sqlfluff.md
84-
[Ruff]: ./ruff.md
85-
[markdownlint]: ./markdownlint.md
86-
[LanguageTool]: ./languagetool.md
87-
[Biome]: ./biome.md
88-
[Hadolint]: ./hadolint.md
89-
[SwiftLint]: ./swiftlint.md
90-
[PHPStan]: ./phpstan.md
91-
[golangci-lint]: ./golangci-lint.md
92-
[YAMLlint]: ./yamllint.md
93-
[Gitleaks]: ./gitleaks.md
94-
[Checkov]: ./checkov.md
95-
[detekt]: ./detekt.md
96-
[RuboCop]: ./rubocop.md
97-
[Buf]: ./buf.md
98-
[actionlint]: ./actionlint.md
99-
[Regal]: ./regal.md
100-
[PMD]: ./pmd.md
101-
[Cppcheck]: ./cppcheck.md
102-
[CircleCI]: ./circleci.md
103-
[Semgrep]: ./semgrep.md
104-
[Pipeline]: ./pipeline-remediation.md
105-
[PrismaLint]: ./prisma-lint.md
106-
[oxlint]: ./oxlint.md
107-
[ShopifyCLI]: ./shopify-cli.md
45+
## What's next
46+
47+
- For a complete list of tools that CodeRabbit supports, see [Supported tools](/tools/list).

‎sidebars.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ const sidebars: SidebarsConfig = {
145145
label: "Supported tools",
146146
collapsed: true,
147147
items: [
148+
"tools/list",
148149
"tools/actionlint",
149150
"tools/biome",
150151
"tools/buf",
@@ -157,6 +158,7 @@ const sidebars: SidebarsConfig = {
157158
"tools/golangci-lint",
158159
"tools/hadolint",
159160
"tools/languagetool",
161+
"tools/luacheck",
160162
"tools/markdownlint",
161163
"tools/oxlint",
162164
"tools/phpstan",

‎static/schema/schema.v2.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,19 @@
843843
"additionalProperties": false,
844844
"default": {},
845845
"description": "Configuration for Shopify Theme Check to ensure theme quality and best practices"
846+
},
847+
"luacheck": {
848+
"type": "object",
849+
"properties": {
850+
"enabled": {
851+
"type": "boolean",
852+
"default": true,
853+
"description": "Enable Lua code linting | Luacheck helps maintain consistent and error-free Lua code | v1.2.0"
854+
}
855+
},
856+
"additionalProperties": false,
857+
"default": {},
858+
"description": "Configuration for Lua code linting to ensure code quality"
846859
}
847860
},
848861
"additionalProperties": false,

0 commit comments

Comments
 (0)