Merge branch 'main' into split-commands

jmacdotorg · web-flow · commit 40d6c7d11687 · 2025-05-21T14:23:47.000-04:00
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,30 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+## May 19, 2025
+
+### Lua Support with Luacheck
+
+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.
+
+## May 14, 2025
+
+### CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉
+
+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._
+
+**Why you'll love it:**
+
+- 📝 **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.
+- 🚀 **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.
+- 🛠️ **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.
+- 🧩 **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.
+
+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.
+
+- [Join the launch discussion on Discord](https://discord.com/channels/1134356397673414807/1145813948193575023/1372210767838842950)
+- [Install the CodeRabbit VSCode Extension](https://coderabbit.link/vscode)
+
 ## April 19, 2025
 
 ### Docstring Path Instructions
diff --git a/docs/reference/caching.md b/docs/reference/caching.md
@@ -0,0 +1,20 @@
+# Caching
+
+CodeRabbit provides caching capabilities for code and dependencies to accelerate the review process. This feature enhances your development workflow by delivering faster feedback.
+
+## Security and Privacy
+
+- Cached data is encrypted (except for OSS projects)
+- Cache expires after a maximum of one week
+- Cached data is used exclusively for speeding up reviews
+
+## Configuration
+
+You can opt out of caching in two ways:
+
+1. **Disable Cache**: Configure `Review - Disable Cache` at either:
+
+   - Organization level
+   - Repository level
+
+2. **Disable Data Retention**: Turn off the `Data Retention` setting in your Organization Settings to disable all data retention across your organization.
diff --git a/docs/tools/list.md b/docs/tools/list.md
@@ -27,6 +27,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 | JSX                         | [Biome][Biome], [oxlint][oxlint]                           | Code Quality                                        |
 | Kotlin                      | [detekt][detekt]                                           | Code Quality                                        |
 | Kubernetes                  | [Checkov][Checkov]                                         | Code Security                                       |
+| Lua                         | [Luacheck][Luacheck]                                       | Code Quality                                        |
 | Markdown                    | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking                      |
 | PHP                         | [PHPStan][PHPStan]                                         | Code Quality                                        |
 | Plaintext                   | [LanguageTool][LanguageTool]                               | Grammar and Spell Checking                          |
@@ -72,3 +73,4 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 [PrismaLint]: /tools/prisma-lint.md
 [oxlint]: /tools/oxlint.md
 [ShopifyCLI]: /tools/shopify-cli.md
+[Luacheck]: /tools/luacheck.md
diff --git a/docs/tools/luacheck.md b/docs/tools/luacheck.md
@@ -0,0 +1,49 @@
+---
+title: Luacheck
+sidebar_label: Luacheck
+description: CodeRabbit's guide to Luacheck.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+[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.
+
+## Supported Files
+
+Luacheck will run on files with the following extensions:
+
+- `.lua`
+
+## Configuration
+
+Luacheck supports the following configuration files:
+
+- `.luacheckrc`
+- `luacheckrc`
+- `.luacheckrc.lua`
+- `luacheckrc.lua`
+
+:::note
+
+Luacheck does not require configuration to run. If no configuration file is found, it will use default settings.
+
+:::
+
+## Features
+
+Luacheck can detect:
+
+- Usage of undefined global variables
+- Unused variables and values
+- Accessing uninitialized variables
+- Unreachable code
+- And many more issues
+
+## Links
+
+- [Luacheck GitHub Repository](https://github.com/mpeterv/luacheck)
+- [Luacheck Documentation](https://luacheck.readthedocs.io/)
diff --git a/sidebars.ts b/sidebars.ts
@@ -163,6 +163,7 @@ const sidebars: SidebarsConfig = {
 						"tools/golangci-lint",
 						"tools/hadolint",
 						"tools/languagetool",
+						"tools/luacheck",
 						"tools/markdownlint",
 						"tools/oxlint",
 						"tools/phpstan",
@@ -179,6 +180,7 @@ const sidebars: SidebarsConfig = {
 						"tools/yamllint",
 					],
 				},
+				"reference/caching",
 			],
 		},
 		{
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
@@ -843,6 +843,19 @@
 									"additionalProperties": false,
 									"default": {},
 									"description": "Configuration for Shopify Theme Check to ensure theme quality and best practices"
+								},
+								"luacheck": {
+									"type": "object",
+									"properties": {
+										"enabled": {
+											"type": "boolean",
+											"default": true,
+											"description": "Enable Lua code linting | Luacheck helps maintain consistent and error-free Lua code | v1.2.0"
+										}
+									},
+									"additionalProperties": false,
+									"default": {},
+									"description": "Configuration for Lua code linting to ensure code quality"
 								}
 							},
 							"additionalProperties": false,
