refactor: linting, naming

Author: AntoineGS

lua/copilot/auth/init.lua

@@ -153,7 +153,7 @@ function M.find_config_path()
 end
 
 ---@return table|nil
-M.get_creds = function()
+function M.get_creds()
   local filename = M.find_config_path() .. "/github-copilot/apps.json"
 
   if vim.fn.filereadable(filename) == 0 then

lua/copilot/util.lua

@@ -110,7 +110,7 @@ function M.get_doc_params(overrides)
   return params
 end
 
-M.get_plugin_path = function()
+function M.get_plugin_path()
   local copilot_path = vim.api.nvim_get_runtime_file("lua/copilot/init.lua", false)[1]
   if vim.fn.filereadable(copilot_path) ~= 0 then
     return vim.fn.fnamemodify(copilot_path, ":h:h:h")
@@ -189,7 +189,7 @@ end
 ---@param cmd string|string[]
 ---@param append string|string[]
 ---@return string[]
-M.append_command = function(cmd, append)
+function M.append_command(cmd, append)
   local full_cmd = {}
 
   -- first append the base command

tests/test_nodejs_stubs.lua renamed to tests/stubs/nodejs.lua

@@ -1,19 +1,21 @@
 -- these are helper functions for testing the nodejs LSP integration
 -- they stub out system interactions for verifying access to node and the LSP script
 
-Stub = {}
+M = {}
 
-Stub.default_server_path = "copilot/js/language-server.js"
-Stub.custom_server_path = "custom/path/to/language-server.js"
+M.default_server_path = "copilot/js/language-server.js"
+M.custom_server_path = "custom/path/to/language-server.js"
 
 ---@param stdout string the stdout that will be returned by the stubbed vim.system
 ---@param code integer the exit code that will be returned by the stubbed vim.system
 ---@param fail boolean if true, vim.system will error when called
 ---@param callback function the function to call while vim.system is stubbed
 ---@return table|nil captured_args -- the arguments vim.system was called with
-Stub.process = function(stdout, code, fail, callback)
+function M.process(stdout, code, fail, callback)
   local captured_args = nil
   local original_vim_system = vim.system
+
+  ---@diagnostic disable-next-line: duplicate-set-field
   vim.system = function(cmd)
     captured_args = cmd
     if fail then
@@ -23,57 +25,63 @@ Stub.process = function(stdout, code, fail, callback)
       wait = function()
         return {
           stdout = stdout .. "\n",
-          code = code
+          code = code,
         }
-      end
+      end,
     }
   end
   -- wrap callback in pcall to ensure vim.system is restored if callback errors
   local ok, err = pcall(callback)
   vim.system = original_vim_system
-  if not ok then error(err) end
+  if not ok then
+    error(err)
+  end
   return captured_args
 end
 
-Stub.valid_node_version = "20.0.0"
-Stub.invalid_node_version = "10.0.0"
+M.valid_node_version = "20.0.0"
+M.invalid_node_version = "10.0.0"
 
 ---Convenience wrapper for Stub.process for a valid Node.js version (>= 20)
-Stub.valid_node = function(callback)
-  return Stub.process("v"..Stub.valid_node_version, 0, false, callback)
+function M.valid_node(callback)
+  return M.process("v" .. M.valid_node_version, 0, false, callback)
 end
 
 ---Convenience wrapper for Stub.process for an invalid Node.js version (< 20)
-Stub.invalid_node = function(callback)
-  return Stub.process("v"..Stub.invalid_node_version, 0, false, callback)
+function M.invalid_node(callback)
+  return M.process("v" .. M.invalid_node_version, 0, false, callback)
 end
 
 ---@param callback function the function to call while vim.api.nvim_get_runtime_file is stubbed
 ---@return string|nil captured_path -- the path vim.api.nvim_get_runtime_file was called with
-Stub.get_runtime_server_path = function(callback)
+function M.get_runtime_server_path(callback)
   local captured_path = nil
 
   local original_get_file = vim.api.nvim_get_runtime_file
+  ---@diagnostic disable-next-line: duplicate-set-field
   vim.api.nvim_get_runtime_file = function(path)
     captured_path = path
-    return { vim.fn.expand(Stub.default_server_path) }
+    return { vim.fn.expand(M.default_server_path) }
   end
 
   local original_filereadable = vim.fn.filereadable
+  ---@diagnostic disable-next-line: duplicate-set-field
   vim.fn.filereadable = function()
     return 1
   end
 
   -- stub valid node version for callback so setup() succeeds
-  Stub.valid_node(function()
+  M.valid_node(function()
     -- wrap callback in pcall to ensure vim.api.nvim_get_runtime_file is restored if callback errors
     local ok, err = pcall(callback)
     vim.api.nvim_get_runtime_file = original_get_file
     vim.fn.filereadable = original_filereadable
-    if not ok then error(err) end
+    if not ok then
+      error(err)
+    end
   end)
 
   return captured_path
 end
 
-return Stub
+return M

tests/test_nodejs.lua

@@ -1,5 +1,5 @@
 local eq = MiniTest.expect.equality
-local stub = require("tests.test_nodejs_stubs")
+local stub = require("tests.stubs.nodejs")
 
 local T = MiniTest.new_set({
   hooks = {
@@ -71,6 +71,7 @@ T["get_node_version()"]["handles vim.system failure"] = function()
     nodejs.setup("node")
 
     local _, error = nodejs.get_node_version()
+    error = error or ""
 
     eq(error:find("Could not determine Node.js version") ~= nil, true)
   end)
@@ -83,6 +84,7 @@ T["get_node_version()"]["handles process with non-zero exit code"] = function()
     nodejs.setup("nonexistent-node")
 
     local _, error = nodejs.get_node_version()
+    error = error or ""
 
     eq(error:find("Could not determine Node.js version") ~= nil, true)
   end)
@@ -95,6 +97,7 @@ T["get_node_version()"]["validates node version requirement"] = function()
     nodejs.setup("node")
 
     local _, error = nodejs.get_node_version()
+    error = error or ""
 
     eq(error:find("Node.js version 20 or newer required") ~= nil, true)
   end)