Skip to content

Commit 379987b

Browse files
jmacdotorgjmacdotorg
authored
Merge branch 'main' into readme
2 parents eeeebd7 + e2e3084 commit 379987b

File tree

8 files changed

+246
-77
lines changed

8 files changed

+246
-77
lines changed

‎docs/changelog.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,30 @@ 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+
14+
## May 14, 2025
15+
16+
### CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉
17+
18+
We're thrilled to announce that CodeRabbit's AI code reviews have officially landed inside **VS Code and all its forks, including Cursor and Windsurf!** No more review bottlenecks or context switches: now you can get _instant, inline feedback right in your editor, completely free._
19+
20+
**Why you'll love it:**
21+
22+
- 📝 **Inline Code Reviews**: Senior-dev-level annotation on every line. CodeRabbit becomes your AI pair programmer, annotating staged & unstaged commits before you even open a PR.
23+
- 🚀 **Built for Flow, Not Friction**: Code, review, commit—rise & repeat without breaking your flow state. Reviews run automatically on every commit so you ship faster.
24+
- 🛠️ **Fix-with-AI**: One-Click Fix for quick tweaks; "Fix with AI" hands off more complex suggestions to your favorite coding agent, complete with full context.
25+
- 🧩 **Compatible with Cursor, Windsurf & Language-Agnostic**: Works out of the box on VS Code, Cursor, Windsurf. Supports Java, JavaScript, PHP, Python, TypeScript, Go, Ruby, and more.
26+
27+
Pair these IDE-embedded reviews with our deeper Git-platform reviews for a multi-layered approach that catches more bugs and cuts down overall review time.
28+
29+
- [Join the launch discussion on Discord](https://discord.com/channels/1134356397673414807/1145813948193575023/1372210767838842950)
30+
- [Install the CodeRabbit VSCode Extension](https://coderabbit.link/vscode)
31+
832
## April 19, 2025
933

1034
### Docstring Path Instructions

‎docs/overview/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ No matter how you tune and customize CodeRabbit, its default settings make it us
5858

5959
CodeRabbit integrates in just a few clicks with many popular Git platforms:
6060

61-
- GitHub, including GitHub Enterprise Server
62-
- GitLab, including self-managed GitLab
61+
- GitHub, GitHub Enterprise Cloud, GitHub Enterprise Server,
62+
- GitLab, GitLab Self-Managed
6363
- Azure DevOps
6464
- Bitbucket Cloud
6565

‎docs/reference/caching.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Caching
2+
3+
CodeRabbit provides caching capabilities for code and dependencies to accelerate the review process. This feature enhances your development workflow by delivering faster feedback.
4+
5+
## Security and Privacy
6+
7+
- Cached data is encrypted (except for OSS projects)
8+
- Cache expires after a maximum of one week
9+
- Cached data is used exclusively for speeding up reviews
10+
11+
## Configuration
12+
13+
You can opt out of caching in two ways:
14+
15+
1. **Disable Cache**: Configure `Review - Disable Cache` at either:
16+
17+
- Organization level
18+
- Repository level
19+
20+
2. **Disable Data Retention**: Turn off the `Data Retention` setting in your Organization Settings to disable all data retention across your organization.

‎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: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ const sidebars: SidebarsConfig = {
3030
docsSidebar: [
3131
{
3232
type: "category",
33-
collapsed: false,
33+
collapsed: true,
3434
label: "Get started with CodeRabbit",
3535
items: ["overview/introduction", "getting-started/quickstart"],
3636
},
3737
{
3838
type: "category",
39-
collapsed: false,
39+
collapsed: true,
4040
label: "Add CodeRabbit to your repository",
4141
items: [
4242
"platforms/platforms",
@@ -70,7 +70,7 @@ const sidebars: SidebarsConfig = {
7070
},
7171
{
7272
type: "category",
73-
collapsed: false,
73+
collapsed: true,
7474
label: "Configure CodeRabbit",
7575
items: [
7676
"getting-started/configure-coderabbit",
@@ -81,14 +81,14 @@ const sidebars: SidebarsConfig = {
8181
},
8282
{
8383
type: "category",
84-
collapsed: false,
84+
collapsed: true,
8585
label: "Review pull requests",
8686
items: [
8787
"guides/commands",
8888
"guides/agent_chat",
8989
{
9090
type: "category",
91-
collapsed: false,
91+
collapsed: true,
9292
label: "Analyze and improve your code",
9393
items: [
9494
"integrations/code-graph-analysis",
@@ -99,7 +99,7 @@ const sidebars: SidebarsConfig = {
9999
},
100100
{
101101
type: "category",
102-
collapsed: false,
102+
collapsed: true,
103103
label: "Create and resolve issues",
104104
items: [
105105
"integrations/issue-integrations",
@@ -110,7 +110,7 @@ const sidebars: SidebarsConfig = {
110110
},
111111
{
112112
type: "category",
113-
collapsed: false,
113+
collapsed: true,
114114
label: "Review local changes",
115115
items: [
116116
"guides/about-vscode",
@@ -122,7 +122,7 @@ const sidebars: SidebarsConfig = {
122122
},
123123
{
124124
type: "category",
125-
collapsed: false,
125+
collapsed: true,
126126
label: "Generate reports",
127127
items: [
128128
"guides/ondemand-reports",
@@ -132,7 +132,7 @@ const sidebars: SidebarsConfig = {
132132
},
133133
{
134134
type: "category",
135-
collapsed: false,
135+
collapsed: true,
136136
label: "Reference",
137137
items: [
138138
{
@@ -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",
@@ -173,11 +175,12 @@ const sidebars: SidebarsConfig = {
173175
"tools/yamllint",
174176
],
175177
},
178+
"reference/caching",
176179
],
177180
},
178181
{
179182
type: "category",
180-
collapsed: false,
183+
collapsed: true,
181184
label: "Resources",
182185
items: [
183186
"getting-started/support",

0 commit comments

Comments
 (0)