style: typing improvements

Author: mochaaP

lua/null-ls/client.lua

@@ -99,7 +99,7 @@ end
 
 local M = {}
 
----@param root_dir? string The root directory of the project.
+---@param root_dir string? The root directory of the project.
 M.start_client = function(root_dir)
     local config = {
         name = "null-ls",
@@ -136,8 +136,8 @@ end
 
 --- This function can be asynchronous. Use cb to run code after the buffer has been retried.
 ---
----@param bufnr? number
----@param cb? fun(did_attach: boolean)
+---@param bufnr number?
+---@param cb fun(did_attach: boolean)?
 M.try_add = function(bufnr, cb)
     bufnr = bufnr or api.nvim_get_current_buf()
     if not should_attach(bufnr) then
@@ -191,6 +191,8 @@ M.get_offset_encoding = function()
     return client and client.offset_encoding or "utf-16"
 end
 
+---@param method vim.lsp.protocol.Method|string
+---@param params table
 M.notify_client = function(method, params)
     if not client then
         log:debug(
@@ -202,10 +204,13 @@ M.notify_client = function(method, params)
     if vim.fn.has("nvim-0.11") == 1 then
         client:notify(method, params)
     else
+        ---@diagnostic disable-next-line: param-type-mismatch
         client.notify(method, params)
     end
 end
 
+---@param method vim.lsp.protocol.Method|string
+---@return lsp.Handler handler
 M.resolve_handler = function(method)
     return client and client.handlers[method] or lsp.handlers[method]
 end

lua/null-ls/code-actions.lua

@@ -15,6 +15,8 @@ local postprocess = function(action)
     }
 end
 
+---@param method vim.lsp.protocol.Method
+---@param handler fun(actions: table)
 M.handler = function(method, original_params, handler)
     if method == methods.lsp.CODE_ACTION then
         if not original_params.textDocument then

lua/null-ls/utils/cosmiconfig.lua

@@ -3,7 +3,7 @@ local u = require("null-ls.utils")
 -- Create the default root_pattern for tools using cosmiconfig.
 -- https://github.com/cosmiconfig/cosmiconfig#usage-for-end-users
 ---@param module_name string The module name.
----@param pkg_json_field_name? string The field name in package.json.
+---@param pkg_json_field_name string? The field name in package.json.
 return function(module_name, pkg_json_field_name)
     local patterns = {
         ".{NAME}rc",

lua/null-ls/utils/init.lua

@@ -203,7 +203,7 @@ M.table = {
 
 --- if opt is a function, call it with args; otherwise, return a copy of opt
 ---@param opt any
----@vararg any args
+---@param ... any args
 ---@return any
 M.handle_function_opt = function(opt, ...)
     if type(opt) == "function" then
@@ -283,7 +283,7 @@ M.path = {
 ---@alias root_pattern_cb fun(root_dir: string|nil)
 
 --- creates a callback that returns the first root matching a specified pattern
----@vararg string patterns
+---@param ... string patterns
 ---@return fun(startpath: string, root_pattern_cb): nil root_dir
 M.root_pattern_async = function(...)
     local patterns = util.tbl_flatten({ ... })
@@ -318,7 +318,7 @@ M.root_pattern_async = function(...)
 end
 
 --- creates a callback that returns the first root matching a specified pattern
----@vararg string patterns
+---@param ... string patterns
 ---@return fun(startpath: string): string|nil root_dir
 M.root_pattern = function(...)
     local patterns = util.tbl_flatten({ ... })
@@ -331,7 +331,6 @@ M.root_pattern = function(...)
         -- escape wildcard characters in the path so that it is not treated like a glob
         path = path:gsub("([%[%]%?%*])", "\\%1")
         for _, pattern in ipairs(patterns) do
-            ---@diagnostic disable-next-line: param-type-mismatch
             for _, p in ipairs(vim.fn.glob(M.path.join(path, pattern), true, true)) do
                 if M.path.exists(p) then
                     return path
@@ -352,10 +351,12 @@ M.root_pattern = function(...)
     end
 end
 
+---@module "null-ls.utils.make_params"
 M.make_params = function(...)
     return require("null-ls.utils.make_params")(...)
 end
 
+---@module "null-ls.utils.cosmiconfig"
 M.cosmiconfig = function(...)
     return require("null-ls.utils.cosmiconfig")(...)
 end
@@ -365,7 +366,7 @@ end
 M.get_vcs_root = function()
     local cwd, err_name, err_msg = uv.cwd()
     assert(cwd, string.format("[Error %s]: %s", err_name, err_msg))
-    local vcs_root = M.root_pattern(".git", ".hg", ".svn", ".bzr")(cwd)
+    local vcs_root = M.root_pattern(".git", ".hg", ".svn", ".bzr", ".fossil", "_darcs", ".pijul")(cwd)
     return vcs_root
 end