Feat/luacheck (#349)

alexcoderabbitai · web-flow · commit b0fdbf04656a · 2025-05-19T16:36:58.000-04:00
* adding luacheck

* update changelog

* enhanced

* add sidebar
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,12 @@ 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.
+
 ## April 19, 2025
 
 ### Docstring Path Instructions
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
@@ -158,6 +158,7 @@ const sidebars: SidebarsConfig = {
 						"tools/golangci-lint",
 						"tools/hadolint",
 						"tools/languagetool",
+						"tools/luacheck",
 						"tools/markdownlint",
 						"tools/oxlint",
 						"tools/phpstan",
