test: Add luacheck

Author: andrewferrier

.github/workflows/tests.yaml

@@ -24,6 +24,18 @@ jobs:
           version: latest
           args: --color always --check lua/ tests/
 
+  luacheck:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Prepare
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y luarocks
+          sudo luarocks install luacheck
+      - name: Lint
+        run: luacheck lua/
+
   unit_test:
     runs-on: ubuntu-latest
 

.luacheckrc

@@ -0,0 +1 @@
+read_globals = { "vim" }

lua/debugprint/init.lua

@@ -174,20 +174,18 @@ end
 
 local cache_request = {}
 
----@param motion string
 ---@return nil
-M.debugprint_operatorfunc_regular = function(motion)
+M.debugprint_operatorfunc_regular = function()
     addline(cache_request)
     utils_operator.set_callback(
         "v:lua.require'debugprint'.debugprint_operatorfunc_regular"
     )
 end
 
----@param motion string
 ---@return nil
-M.debugprint_operatorfunc_motion = function(motion)
+M.debugprint_operatorfunc_motion = function()
     cache_request.variable_name = utils_buffer.get_operator_selection()
-    M.debugprint_operatorfunc_regular(motion)
+    M.debugprint_operatorfunc_regular()
 end
 
 ---@param opts DebugprintFunctionOptionsInternal
@@ -209,8 +207,9 @@ M.debugprint_regular = function(opts)
     end
 
     cache_request = opts
-    vim.go.operatorfunc =
+    utils_operator.set_operatorfunc(
         "v:lua.require'debugprint'.debugprint_operatorfunc_regular"
+    )
     return "g@l"
 end
 
@@ -228,8 +227,9 @@ M.debugprint = function(opts)
 
     if func_opts.motion == true then
         cache_request = func_opts
-        vim.go.operatorfunc =
+        utils_operator.set_operatorfunc(
             "v:lua.require'debugprint'.debugprint_operatorfunc_motion"
+        )
         return "g@"
     else
         cache_request = {}

lua/debugprint/utils/operator.lua

@@ -3,12 +3,17 @@ local M = {}
 ---@return nil
 M.NOOP = function() end
 
+---@param value string
+M.set_operatorfunc = function(value)
+    vim.api.nvim_set_option_value("operatorfunc", value, {})
+end
+
 ---@param func_name string
 ---@return nil
 M.set_callback = function(func_name)
-    vim.go.operatorfunc = "v:lua.require'debugprint.utils.operator'.NOOP"
+    M.set_operatorfunc("v:lua.require'debugprint.utils.operator'.NOOP")
     vim.cmd("normal! g@l")
-    vim.go.operatorfunc = func_name
+    M.set_operatorfunc(func_name)
 end
 
 return M