init: luacheck (#441)

Author: Conni2461

.github/workflows/default.yml

@@ -49,3 +49,18 @@ jobs:
           version: latest
           # CLI arguments
           args: --color always --check .
+
+  luacheck:
+    name: Luacheck
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y luarocks
+          sudo luarocks install luacheck
+
+      - name: Lint
+        run: sudo make lint

.luacheckrc

@@ -0,0 +1,60 @@
+-- Rerun tests only if their modification time changed.
+cache = true
+
+std = luajit
+codes = true
+
+self = false
+
+-- Glorious list of warnings: https://luacheck.readthedocs.io/en/stable/warnings.html
+ignore = {
+  "212", -- Unused argument, In the case of callback function, _arg_name is easier to understand than _, so this option is set to off.
+  "122", -- Indirectly setting a readonly global
+}
+
+globals = {
+  "_",
+  "_PlenaryLeafTable",
+  "_PlenaryBustedOldAssert",
+  "_AssociatedBufs",
+}
+
+-- Global objects defined by the C code
+read_globals = {
+  "vim",
+}
+
+exclude_files = {
+  "lua/plenary/profile/lua_profiler.lua",
+  "lua/plenary/profile/memory_profiler.lua",
+  "lua/plenary/vararg/rotate.lua",
+  "lua/plenary/async_lib/*.lua",
+}
+
+files = {
+  ["lua/plenary/busted.lua"] = {
+    globals = {
+      "describe",
+      "it",
+      "pending",
+      "before_each",
+      "after_each",
+      "clear",
+      "assert",
+      "print",
+    },
+  },
+  ["lua/plenary/async/init.lua"] = {
+    globals = {
+      "a",
+    },
+  },
+  ["lua/plenary/async/tests.lua"] = {
+    globals = {
+      "describe",
+      "it",
+      "before_each",
+      "after_each",
+    },
+  },
+}

Makefile

@@ -1,9 +1,13 @@
+.PHONY: test generate_filetypes lint luarocks_upload test_luarocks_install
 test:
 	nvim --headless --noplugin -u scripts/minimal.vim -c "PlenaryBustedDirectory tests/plenary/ {minimal_init = 'tests/minimal_init.vim'}"
 
 generate_filetypes:
 	nvim --headless -c 'luafile scripts/update_filetypes_from_github.lua' -c 'qa!'
 
+lint:
+	luacheck lua/plenary
+
 luarocks_upload:
 	bash ./scripts/luarocks-upload.sh
 

lua/plenary/async/control.lua

@@ -33,7 +33,8 @@ function Condvar:notify_all()
   end
 
   for i = 1, len do
-    -- table.remove will ensure that indexes are correct and make "ipairs" safe, which is not the case for "self.handles[i] = nil"
+    -- table.remove will ensure that indexes are correct and make "ipairs" safe,
+    -- which is not the case for "self.handles[i] = nil"
     table.remove(self.handles, i)
   end
 end
@@ -93,8 +94,7 @@ Semaphore.acquire = a.wrap(function(self, callback)
 
     if self.permits > 0 and #self.handles > 0 then
       self.permits = self.permits - 1
-      local callback = table.remove(self.handles)
-      callback(self_permit)
+      table.remove(self.handles)(self_permit)
     end
   end
 

lua/plenary/async/init.lua

@@ -28,9 +28,6 @@ local exports = setmetatable(require "plenary.async.async", {
 
 exports.tests.add_globals = function()
   a = exports
-  async = exports.async
-  await = exports.await
-  await_all = exports.await_all
 
   -- must prefix with a or stack overflow, plenary.test harness already added it
   a.describe = exports.tests.describe
@@ -44,9 +41,6 @@ exports.tests.add_to_env = function()
   local env = getfenv(2)
 
   env.a = exports
-  env.async = exports.async
-  env.await = exports.await
-  env.await_all = exports.await_all
 
   -- must prefix with a or stack overflow, plenary.test harness already added it
   env.a.describe = exports.tests.describe

lua/plenary/async/structs.lua

@@ -1,6 +1,6 @@
 local M = {}
 
-Deque = {}
+local Deque = {}
 Deque.__index = Deque
 
 ---@class Deque

lua/plenary/async/util.lua

@@ -24,8 +24,8 @@ M.block_on = function(async_function, timeout)
 
   local stat, ret
 
-  a.run(async_function, function(_stat, ...)
-    stat = _stat
+  a.run(async_function, function(stat_, ...)
+    stat = stat_
     ret = { ... }
   end)
 

lua/plenary/benchmark/init.lua

@@ -1,4 +1,3 @@
-local B = {}
 local stat = require "plenary.benchmark.stat"
 
 local get_stats = function(results)

lua/plenary/bit.lua

@@ -213,7 +213,6 @@ function M.extract(n, field, width) -- Lua5.2 inspired
   width = width or 1
   return band(rshift(n, field), 2^width-1)
 end
-local extract = M.extract
 
 function M.replace(n, v, field, width) -- Lua5.2 inspired
   width = width or 1
@@ -222,7 +221,6 @@ function M.replace(n, v, field, width) -- Lua5.2 inspired
   local mask = bnot(lshift(mask1, field))
   return band(n, mask) + lshift(v, field)
 end
-local replace = M.replace
 
 function M.bswap(x)  -- BitOp style
   local a = band(x, 0xff); x = rshift(x, 8)

lua/plenary/busted.lua

@@ -183,7 +183,7 @@ mod.it = function(desc, func)
   -- TODO: We should figure out how to determine whether
   -- and assert failed or whether it was an error...
 
-  local to_insert, printed
+  local to_insert
   if not ok then
     to_insert = results.fail
     test_result.msg = msg