對(duì)于我們 OpenResty 開發(fā)中，日常開發(fā)的都是 Lua 代碼，所以我們可以使用 luacheck 這款靜態(tài)代碼檢測(cè)工具來(lái)幫助我們檢查，比較好的一點(diǎn)是這款工具對(duì) ngx_lua 做了一些支持，我們使用的 ngx 變量在開啟了配置 --std ngx_lua 后即可被 luacheck 識(shí)別，而不會(huì)被認(rèn)為是未定義的變量。

我們可以通過 luarocks 來(lái)安裝:

? luarocks install luacheck

使用也很方便，只需要 luacheck filename or directory 即可。

$ 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

當(dāng)然你也可以指定一些參數(shù)來(lái)運(yùn)行 luacheck，常見的有 std、ignore、globals 等，我們一般會(huì)必選上 --std ngx_lua 來(lái)識(shí)別 ngx_lua 的全局變量，具體的規(guī)則可以查看官方文檔

除了使用命令行參數(shù)，luacheck 還支持使用配置文件的形式，這也是我們推薦的做法。luacheck 使用時(shí)會(huì)優(yōu)先查找當(dāng)前目錄下的 .luacheckrc 文件，未找到則去上層目錄查找，以此類推。所以我們可以在項(xiàng)目的根目錄下放置一個(gè)我們配置好的 .luacheckrc 文件以便之后使用。

luacheck 也可以集成進(jìn)編輯器使用，支持的有 Vim，Sublime Text，Atom，Emacs，Brackets。基本主流的編輯器都有支持。具體可以看相應(yīng)的使用文檔，這里就不做說(shuō)明了。

這里特別說(shuō)一下的是，我們?cè)陧?xiàng)目中使用了 git pre-commit hooks 來(lái)進(jìn)行靜態(tài)檢查，在 git commit 前會(huì)檢測(cè)本次提交修改和新增的代碼，判斷是否通過了 luacheck 的檢測(cè)，未通過會(huì)給出提示并詢問是否退出這次 commit。這一切都是通過 git hooks 來(lái)做的，顧名思義我們的鉤子是下在 commit 這個(gè)動(dòng)作上的，只要進(jìn)行了 commit 操作，就會(huì)觸發(fā)我們的鉤子。git 內(nèi)置了一些鉤子，不同的 git 操作會(huì)觸發(fā)不同的鉤子，這些鉤子放在項(xiàng)目文件夾的 .git/hooks/ 文件夾下，我們這里用到的是 pre-commit。

#!/usr/bin/env bash
lua_files=$(git status -s|awk '{if (($1=="M"||$1=="A") && $2 ~ /.lua$/)print $2;}')

if [[ "$lua_files" != "" ]]; then
    result=$(luacheck $lua_files)

    if [[ "$result" =~ .*:.*:.*: ]]; then
        echo "$result"
        echo ""
        exec < /dev/tty
        read -p "Abort commit?(Y/n)"

        if [[ "$REPLY" == y* ]] || [[ "$REPLY" == Y* ]]; then
            echo "Abort commit"
            exit 1
        fi
    fi
fi

上一篇：Mac OS X 平臺(tái)安裝下一篇：單元測(cè)試