[Refactor/Bugfix] Improve null ls handler (#1277)

7 files changed, 287 insertions, 144 deletions

diff --git a/lua/lsp/init.lua b/lua/lsp/init.lua
index e4ea02db..891147e5 100644
--- a/lua/lsp/init.lua
+++ b/lua/lsp/init.lua
@@ -1,5 +1,6 @@
 local M = {}
 local Log = require "core.log"
+
 function M.config()
   vim.lsp.protocol.CompletionItemKind = lvim.lsp.completion.item_kind
 
@@ -127,13 +128,13 @@ function M.common_on_attach(client, bufnr)
 end
 
 function M.setup(lang)
+  local lsp_utils = require "lsp.utils"
   local lsp = lvim.lang[lang].lsp
-  if require("utils").check_lsp_client_active(lsp.provider) then
+  if lsp_utils.is_client_active(lsp.provider) then
     return
   end
 
   local overrides = lvim.lsp.override
-
   if type(overrides) == "table" then
     if vim.tbl_contains(overrides, lang) then
       return
diff --git a/lua/lsp/null-ls.lua b/lua/lsp/null-ls.lua
deleted file mode 100644
index 2ce98f2c..00000000
--- a/lua/lsp/null-ls.lua
+++ /dev/null
@@ -1,142 +0,0 @@
-local M = {}
-local Log = require "core.log"
-
-local null_ls = require "null-ls"
-
-local nodejs_local_providers = { "prettier", "prettierd", "prettier_d_slim", "eslint_d", "eslint" }
-
-M.requested_providers = {}
-
-function M.get_registered_providers_by_filetype(ft)
-  local matches = {}
-  for _, provider in pairs(M.requested_providers) do
-    if vim.tbl_contains(provider.filetypes, ft) then
-      local provider_name = provider.name
-      -- special case: show "eslint_d" instead of eslint
-      -- https://github.com/jose-elias-alvarez/null-ls.nvim/blob/9b8458bd1648e84169a7e8638091ba15c2f20fc0/doc/BUILTINS.md#eslint
-      if string.find(provider._opts.command, "eslint_d") then
-        provider_name = "eslint_d"
-      end
-      table.insert(matches, provider_name)
-    end
-  end
-
-  return matches
-end
-
-function M.get_missing_providers_by_filetype(ft)
-  local matches = {}
-  for _, provider in pairs(M.requested_providers) do
-    if vim.tbl_contains(provider.filetypes, ft) then
-      local provider_name = provider.name
-
-      table.insert(matches, provider_name)
-    end
-  end
-
-  return matches
-end
-
-local function register_failed_request(ft, provider, operation)
-  if not lvim.lang[ft][operation]._failed_requests then
-    lvim.lang[ft][operation]._failed_requests = {}
-  end
-  table.insert(lvim.lang[ft][operation]._failed_requests, provider)
-end
-
-local function validate_nodejs_provider(provider)
-  local command_path
-  local root_dir
-  if lvim.builtin.rooter.active then
-    --- use vim-rooter to set root_dir
-    vim.cmd "let root_dir = FindRootDirectory()"
-    root_dir = vim.api.nvim_get_var "root_dir"
-  else
-    --- use LSP to set root_dir
-    local ts_client = require("utils").get_active_client_by_ft "typescript"
-    if ts_client == nil then
-      Log:get_default().error "Unable to determine root directory since tsserver didn't start correctly"
-      return
-    end
-    root_dir = ts_client.config.root_dir
-  end
-  local local_nodejs_command = root_dir .. "/node_modules/.bin/" .. provider._opts.command
-  Log:get_default().debug("checking for local node module: ", vim.inspect(provider))
-
-  if vim.fn.executable(local_nodejs_command) == 1 then
-    command_path = local_nodejs_command
-  elseif vim.fn.executable(provider._opts.command) == 1 then
-    Log:get_default().debug("checking in global path instead for node module", provider._opts.command)
-    command_path = provider._opts.command
-  else
-    Log:get_default().debug("Unable to find node module", provider._opts.command)
-  end
-  return command_path
-end
-
-local function validate_provider_request(provider)
-  if provider == "" or provider == nil then
-    return
-  end
-  -- NOTE: we can't use provider.name because eslint_d uses eslint name
-  if vim.tbl_contains(nodejs_local_providers, provider._opts.command) then
-    return validate_nodejs_provider(provider)
-  end
-  if vim.fn.executable(provider._opts.command) ~= 1 then
-    Log:get_default().debug("Unable to find the path for", vim.inspect(provider))
-    Log:get_default().warn("Unable to find the path for ", provider._opts.command)
-    return
-  end
-  return provider._opts.command
-end
-
--- TODO: for linters and formatters with spaces and '-' replace with '_'
-function M.setup(filetype)
-  for _, formatter in pairs(lvim.lang[filetype].formatters) do
-    Log:get_default().debug("validating format provider: ", formatter.exe)
-    local builtin_formatter = null_ls.builtins.formatting[formatter.exe]
-    if not vim.tbl_contains(M.requested_providers, builtin_formatter) then
-      -- FIXME: why doesn't this work?
-      builtin_formatter._opts.args = formatter.args or builtin_formatter._opts.args
-      -- builtin_formatter._opts.to_stdin = formatter.stdin or builtin_formatter._opts.to_stdin
-      local resolved_path = validate_provider_request(builtin_formatter)
-      if resolved_path then
-        builtin_formatter._opts.command = resolved_path
-        table.insert(M.requested_providers, builtin_formatter)
-        Log:get_default().info("Using format provider", builtin_formatter.name)
-      else
-        -- mark it here to avoid re-doing the lookup again
-        register_failed_request(filetype, formatter.exe, "formatters")
-      end
-    end
-  end
-
-  for _, linter in pairs(lvim.lang[filetype].linters) do
-    local builtin_diagnoser = null_ls.builtins.diagnostics[linter.exe]
-    Log:get_default().debug("validating lint provider: ", linter.exe)
-    -- special case: fallback to "eslint"
-    -- https://github.com/jose-elias-alvarez/null-ls.nvim/blob/9b8458bd1648e84169a7e8638091ba15c2f20fc0/doc/BUILTINS.md#eslint
-    -- if provider.exe
-    if linter.exe == "eslint_d" then
-      builtin_diagnoser = null_ls.builtins.diagnostics.eslint.with { command = "eslint_d" }
-    end
-    if not vim.tbl_contains(M.requested_providers, builtin_diagnoser) then
-      -- FIXME: why doesn't this work?
-      -- builtin_diagnoser._opts.args = linter.args or builtin_diagnoser._opts.args
-      -- builtin_diagnoser._opts.to_stdin = linter.stdin or builtin_diagnoser._opts.to_stdin
-      local resolved_path = validate_provider_request(builtin_diagnoser)
-      if resolved_path then
-        builtin_diagnoser._opts.command = resolved_path
-        table.insert(M.requested_providers, builtin_diagnoser)
-        Log:get_default().info("Using linter provider", builtin_diagnoser.name)
-      else
-        -- mark it here to avoid re-doing the lookup again
-        register_failed_request(filetype, linter.exe, "linters")
-      end
-    end
-  end
-
-  null_ls.register { sources = M.requested_providers }
-end
-
-return M
diff --git a/lua/lsp/null-ls/formatters.lua b/lua/lsp/null-ls/formatters.lua
new file mode 100644
index 00000000..dd88fa60
--- /dev/null
+++ b/lua/lsp/null-ls/formatters.lua
@@ -0,0 +1,79 @@
+local M = {}
+local formatters_by_ft = {}
+
+local null_ls = require "null-ls"
+local services = require "lsp.null-ls.services"
+local logger = require("core.log"):get_default()
+
+local function list_names(formatters, options)
+  options = options or {}
+  local names = {}
+
+  local filter = options.filter or "supported"
+  for name, _ in pairs(formatters[filter]) do
+    table.insert(names, name)
+  end
+
+  return names
+end
+
+function M.list_supported_names(filetype)
+  if not formatters_by_ft[filetype] then
+    return {}
+  end
+  return list_names(formatters_by_ft[filetype], { filter = "supported" })
+end
+
+function M.list_unsupported_names(filetype)
+  if not formatters_by_ft[filetype] then
+    return {}
+  end
+  return list_names(formatters_by_ft[filetype], { filter = "unsupported" })
+end
+
+function M.list_available(filetype)
+  local formatters = {}
+  for _, provider in pairs(null_ls.builtins.formatting) do
+    -- TODO: Add support for wildcard filetypes
+    if vim.tbl_contains(provider.filetypes or {}, filetype) then
+      table.insert(formatters, provider.name)
+    end
+  end
+
+  return formatters
+end
+
+function M.list_configured(formatter_configs)
+  local formatters, errors = {}, {}
+
+  for _, fmt_config in ipairs(formatter_configs) do
+    local formatter = null_ls.builtins.formatting[fmt_config.exe]
+
+    if not formatter then
+      logger.error("Not a valid formatter:", fmt_config.exe)
+      errors[fmt_config.exe] = {} -- Add data here when necessary
+    else
+      local formatter_cmd = services.find_command(formatter._opts.command)
+      if not formatter_cmd then
+        logger.warn("Not found:", formatter._opts.command)
+        errors[fmt_config.exe] = {} -- Add data here when necessary
+      else
+        logger.info("Using formatter:", formatter_cmd)
+        formatters[fmt_config.exe] = formatter.with { command = formatter_cmd, args = fmt_config.args }
+      end
+    end
+  end
+
+  return { supported = formatters, unsupported = errors }
+end
+
+function M.setup(filetype, options)
+  if formatters_by_ft[filetype] and not options.force_reload then
+    return
+  end
+
+  formatters_by_ft[filetype] = M.list_configured(lvim.lang[filetype].formatters)
+  null_ls.register { sources = formatters_by_ft[filetype].supported }
+end
+
+return M
diff --git a/lua/lsp/null-ls/init.lua b/lua/lsp/null-ls/init.lua
new file mode 100644
index 00000000..8691982e
--- /dev/null
+++ b/lua/lsp/null-ls/init.lua
@@ -0,0 +1,44 @@
+local M = {}
+
+function M.list_supported_provider_names(filetype)
+  local names = {}
+
+  local formatters = require "lsp.null-ls.formatters"
+  local linters = require "lsp.null-ls.linters"
+
+  vim.list_extend(names, formatters.list_supported_names(filetype))
+  vim.list_extend(names, linters.list_supported_names(filetype))
+
+  return names
+end
+
+function M.list_unsupported_provider_names(filetype)
+  local names = {}
+
+  local formatters = require "lsp.null-ls.formatters"
+  local linters = require "lsp.null-ls.linters"
+
+  vim.list_extend(names, formatters.list_unsupported_names(filetype))
+  vim.list_extend(names, linters.list_unsupported_names(filetype))
+
+  return names
+end
+
+-- TODO: for linters and formatters with spaces and '-' replace with '_'
+function M.setup(filetype, options)
+  options = options or {}
+
+  local ok, _ = pcall(require, "null-ls")
+  if not ok then
+    require("core.log"):get_default().error "Missing null-ls dependency"
+    return
+  end
+
+  local formatters = require "lsp.null-ls.formatters"
+  local linters = require "lsp.null-ls.linters"
+
+  formatters.setup(filetype, options)
+  linters.setup(filetype, options)
+end
+
+return M
diff --git a/lua/lsp/null-ls/linters.lua b/lua/lsp/null-ls/linters.lua
new file mode 100644
index 00000000..780a9c4d
--- /dev/null
+++ b/lua/lsp/null-ls/linters.lua
@@ -0,0 +1,79 @@
+local M = {}
+local linters_by_ft = {}
+
+local null_ls = require "null-ls"
+local services = require "lsp.null-ls.services"
+local logger = require("core.log"):get_default()
+
+local function list_names(linters, options)
+  options = options or {}
+  local names = {}
+
+  local filter = options.filter or "supported"
+  for name, _ in pairs(linters[filter]) do
+    table.insert(names, name)
+  end
+
+  return names
+end
+
+function M.list_supported_names(filetype)
+  if not linters_by_ft[filetype] then
+    return {}
+  end
+  return list_names(linters_by_ft[filetype], { filter = "supported" })
+end
+
+function M.list_unsupported_names(filetype)
+  if not linters_by_ft[filetype] then
+    return {}
+  end
+  return list_names(linters_by_ft[filetype], { filter = "unsupported" })
+end
+
+function M.list_available(filetype)
+  local linters = {}
+  for _, provider in pairs(null_ls.builtins.diagnostics) do
+    -- TODO: Add support for wildcard filetypes
+    if vim.tbl_contains(provider.filetypes or {}, filetype) then
+      table.insert(linters, provider.name)
+    end
+  end
+
+  return linters
+end
+
+function M.list_configured(linter_configs)
+  local linters, errors = {}, {}
+
+  for _, lnt_config in pairs(linter_configs) do
+    local linter = null_ls.builtins.diagnostics[lnt_config.exe]
+
+    if not linter then
+      logger.error("Not a valid linter:", lnt_config.exe)
+      errors[lnt_config.exe] = {} -- Add data here when necessary
+    else
+      local linter_cmd = services.find_command(linter._opts.command)
+      if not linter_cmd then
+        logger.warn("Not found:", linter._opts.command)
+        errors[lnt_config.exe] = {} -- Add data here when necessary
+      else
+        logger.info("Using linter:", linter_cmd)
+        linters[lnt_config.exe] = linter.with { command = linter_cmd, args = lnt_config.args }
+      end
+    end
+  end
+
+  return { supported = linters, unsupported = errors }
+end
+
+function M.setup(filetype, options)
+  if linters_by_ft[filetype] and not options.force_reload then
+    return
+  end
+
+  linters_by_ft[filetype] = M.list_configured(lvim.lang[filetype].linters)
+  null_ls.register { sources = linters_by_ft[filetype].supported }
+end
+
+return M
diff --git a/lua/lsp/null-ls/services.lua b/lua/lsp/null-ls/services.lua
new file mode 100644
index 00000000..89073e5c
--- /dev/null
+++ b/lua/lsp/null-ls/services.lua
@@ -0,0 +1,55 @@
+local M = {}
+
+local logger = require("core.log"):get_default()
+
+local function find_root_dir()
+  if lvim.builtin.rooter.active then
+    --- use vim-rooter to set root_dir
+    vim.cmd "let root_dir = FindRootDirectory()"
+    return vim.api.nvim_get_var "root_dir"
+  end
+
+  -- TODO: Rework this to not make it javascript specific
+  --- use LSP to set root_dir
+  local lsp_utils = require "lsp.utils"
+  local ts_client = lsp_utils.get_active_client_by_ft "typescript"
+  if ts_client == nil then
+    logger.error "Unable to determine root directory since tsserver didn't start correctly"
+    return nil
+  end
+
+  return ts_client.config.root_dir
+end
+
+local function from_node_modules(command)
+  local root_dir = find_root_dir()
+  if not root_dir then
+    return nil
+  end
+
+  return root_dir .. "/node_modules/.bin/" .. command
+end
+
+local local_providers = {
+  prettier = { find = from_node_modules },
+  prettierd = { find = from_node_modules },
+  prettier_d_slim = { find = from_node_modules },
+  eslint_d = { find = from_node_modules },
+  eslint = { find = from_node_modules },
+}
+
+function M.find_command(command)
+  if local_providers[command] then
+    local local_command = local_providers[command].find(command)
+    if local_command and vim.fn.executable(local_command) == 1 then
+      return local_command
+    end
+  end
+
+  if vim.fn.executable(command) == 1 then
+    return command
+  end
+  return nil
+end
+
+return M
diff --git a/lua/lsp/utils.lua b/lua/lsp/utils.lua
new file mode 100644
index 00000000..e28c6085
--- /dev/null
+++ b/lua/lsp/utils.lua
@@ -0,0 +1,27 @@
+local M = {}
+
+function M.is_client_active(name)
+  local clients = vim.lsp.get_active_clients()
+  for _, client in pairs(clients) do
+    if client.name == name then
+      return true
+    end
+  end
+  return false
+end
+
+function M.get_active_client_by_ft(filetype)
+  if not lvim.lang[filetype] or not lvim.lang[filetype].lsp then
+    return nil
+  end
+
+  local clients = vim.lsp.get_active_clients()
+  for _, client in pairs(clients) do
+    if client.name == lvim.lang[filetype].lsp.provider then
+      return client
+    end
+  end
+  return nil
+end
+
+return M