使用 Git Hook 在提交代码前通过 luacheck 自动检查待提交代码

Preface

由于脚本语言解释执行的特性，很多低级错误在运行到问题代码时才会报错，而不是像 C++ 这种静态语言那样在编译期就能由编译器检查出来，这就导致有很多本来在开发期就可以避免的问题，拖到线上才被发现。这里给出一个方案，可以在提交代码前，通过 Git 的 hook/pre-commit 机制，去做一些脚本代码的静态检查。

我用 Lua 比较多，这里就以 Lua 为例来进行说明。Lua 的静态检查工具基本上只有一个 luacheck 可用, 安装很简单，可以使用 luarocks 安装（类似 python 的 pip, 是一个 Lua 的包管理器）：

luarocks install luacheck

安装好以后可以直接在终端使用:

luacheck your_lua_file.lua

luacheck 的配置

默认的 luacheck 配置比较严格，会报很多警告，比如我们自定义的一些全局变量和函数，这当然是我们不希望看到的，既然要检查了，就要做到整个项目里所有文件都是 0 warnings / 0 errors。

配置方法：
新建 ~/.luacheckrc 文件, 然后在里面加上下面的内容, 这里面是我们项目的一些符号，大家可以根据自己项目实际需求来添加或删除。

-- 这个文件是一个 Lua 文件

-- 每行最大长度，默认 120
max_line_length = 9999

-- 忽略的符号
ignore = {
    "init",
    "exit",
    "accept",
    "response",
    "class",
}

-- 全局变量
globals = {
    "Log",
    "table.empty",
    "table.size",
    "table.merge",
    "table.indexof",
    "table.keys",
    "table.values",
    "table.valuestring",
    "table.copy",
    "table.deepcopy",
    "table.first",
    "table.deepmerge",
    "table.walk",
    "table.clear",
    "string.split",
    "string.ltrim",
    "string.rtrim",
    "string.trim",
    "string.repeated",
    "string.nocase",
    "string.nocasefind",
    "enum",
    "ASSERT",
    "ANSI_COLOR",
    "const",
    "m