ci: add linting step with LuaCheck to GitHub Actions

Author: wpjunior

.github/workflows/deploy.yml

@@ -7,6 +7,23 @@ on:
   pull_request:
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install LuaJIT and LuaRocks
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y luajit luarocks
+
+      - name: Install luacheck
+        run: sudo luarocks install luacheck
+
+      - name: Run LuaCheck
+        run: make lint
+
   test-unit:
     runs-on: ubuntu-latest
     steps:

Makefile

@@ -18,4 +18,8 @@ test:
 	done
 
 test-e2e:
-	@go test -v ./...
+	@go test -v ./...
+
+lint:
+	luacheck --std ngx_lua ./lib/
+	luacheck -g ./test/

lib/resty/libjwt/cached.lua

@@ -2,7 +2,7 @@ local cached = {}
 
 local instance = nil
 
-function cached:getInstance()
+function cached.getInstance()
     if not instance then
         instance = {
             data = {}

lib/resty/libjwt/decode.lua

@@ -14,7 +14,8 @@ function _M.jwt(jwt)
         return nil, err
     end
 
-    local payload, err = b64.decode_base64url(payload_b64)
+    local payload
+    payload, err = b64.decode_base64url(payload_b64)
     if err then
         return nil, err
     end

lib/resty/libjwt/init.lua

@@ -4,6 +4,7 @@ local cached = require("resty.libjwt.cached")
 local decode = require("resty.libjwt.decode")
 local cjson = require("cjson.safe")
 local _M = {}
+local ngx = ngx
 
 local open = io.open
 function _M.read_file(path)
@@ -15,20 +16,23 @@ function _M.read_file(path)
 end
 
 local TOKEN_VALID = 0
-function _M.validate(params)
-    local params, err = utils.get_params(params)
+function _M.validate(user_params)
+    local params, err = utils.get_params(user_params)
     if params == nil then
         return false, _M.response_error(err, false)
     end
     if err ~= "" then
         return false, _M.response_error(err, params.return_unauthorized_default)
     end
     local headers = ngx.req.get_headers()
-    local token, err = utils.get_token(headers, params.header_token)
+
+    local token
+    token, err = utils.get_token(headers, params.header_token)
     if err ~= "" then
         return false, _M.response_error(err, params.return_unauthorized_default)
     end
-    local parsed_token, err = decode.jwt(token)
+    local parsed_token
+    parsed_token, err = decode.jwt(token)
     if err ~= nil then
         return nil, _M.response_error(err, params.return_unauthorized_default)
     end
@@ -37,7 +41,7 @@ function _M.validate(params)
     end
 
     local files_cached = cached:getInstance()
-    for i, jwks_file in ipairs(params.jwks_files) do
+    for _, jwks_file in ipairs(params.jwks_files) do
         local file
         if files_cached:get(jwks_file) == nil then
             file = _M.read_file(jwks_file)