Luacheck 技术文档

1. 安装指南

使用 LuaRocks 安装

从命令行运行以下命令（如果需要，请使用 sudo）：

luarocks install luacheck

为了进行并行检查，Luacheck 还需要 LuaLanes，可以通过 LuaRocks 安装：

luarocks install lanes

Windows 二进制下载

对于 Windows 用户，有一个单文件的 64 位二进制分发版，捆绑了 Lua 5.3.4、Luacheck、LuaFileSystem 和 LuaLanes，使用 LuaStatic：

下载链接

2. 项目使用说明

安装完成后，可以通过命令行运行 luacheck 程序。传递要检查的文件列表、rockspecs 或目录（需要 LuaFileSystem）：

luacheck src extra_file.lua another_file.lua

示例输出：

Checking src/good_code.lua               OK
Checking src/bad_code.lua                3 warnings

    src/bad_code.lua:3:23: unused variable length argument
    src/bad_code.lua:7:10: setting non-standard global variable embrace
    src/bad_code.lua:8:10: variable opt was previously defined as an argument on line 7

Checking src/python_code.lua             1 error

    src/python_code.lua:1:6: expected '=' near '__future__'

Checking extra_file.lua                  5 warnings

    extra_file.lua:3:18: unused argument baz
    extra_file.lua:4:8: unused loop variable i
    extra_file.lua:13:7: accessing uninitialized variable a
    extra_file.lua:14:1: value assigned to variable x is unused
    extra_file.lua:21:7: variable z is never accessed

Checking another_file.lua                2 warnings

    another_file.lua:2:7: unused variable height
    another_file.lua:3:7: accessing undefined variable heigth

Total: 10 warnings / 1 error in 5 files

更多信息，请参阅 文档。

3. 项目 API 使用文档

Luacheck 的 API 文档可以在 在线文档 中找到。如果通过 LuaRocks 安装了 Luacheck，可以使用以下命令在本地浏览文档：

luarocks doc luacheck

文档也可以使用 Sphinx 构建：

sphinx-build docsrc doc

生成的文件将在 doc/ 目录中找到。

4. 项目安装方式

Luacheck 可以通过以下几种方式安装：

使用 LuaRocks

luarocks install luacheck

Windows 二进制下载

下载链接

从源码构建

1. 克隆 Luacheck 仓库：

   git clone https://github.com/mpeterv/luacheck.git
   

2. 进入项目目录并安装开发版本：

   cd luacheck
   luarocks make
   

3. 运行测试：

   busted
   

通过以上步骤，您可以成功安装并使用 Luacheck 进行 Lua 代码的静态分析和检查。