fix!: update command resolver signature to fix caching (#1072)

Jose Alvarez · web-flow · commit 4b403d2d724f · 2022-09-05T15:40:40.000-04:00
diff --git a/lua/null-ls/builtins/code_actions/eslint.lua b/lua/null-ls/builtins/code_actions/eslint.lua
@@ -166,7 +166,7 @@ return h.make_builtin({
             params.messages = output[1].messages
             return code_action_handler(params)
         end,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         cwd = h.cache.by_bufnr(function(params)
             return u.root_pattern(
                 -- https://eslint.org/docs/user-guide/configuring/configuration-files#configuration-file-formats
diff --git a/lua/null-ls/builtins/diagnostics/eslint.lua b/lua/null-ls/builtins/diagnostics/eslint.lua
@@ -42,7 +42,7 @@ return h.make_builtin({
         end,
         use_cache = true,
         on_output = handle_eslint_output,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         cwd = h.cache.by_bufnr(function(params)
             return u.root_pattern(
                 -- https://eslint.org/docs/user-guide/configuring/configuration-files#configuration-file-formats
diff --git a/lua/null-ls/builtins/diagnostics/puglint.lua b/lua/null-ls/builtins/diagnostics/puglint.lua
@@ -34,7 +34,7 @@ return h.make_builtin({
                 groups = { "filename", "row", "col", "message" },
             },
         }),
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
     },
     factory = h.generator_factory,
 })
diff --git a/lua/null-ls/builtins/diagnostics/standardjs.lua b/lua/null-ls/builtins/diagnostics/standardjs.lua
@@ -41,7 +41,7 @@ return h.make_builtin({
                 },
             },
         }),
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
     },
     factory = h.generator_factory,
 })
diff --git a/lua/null-ls/builtins/diagnostics/stylelint.lua b/lua/null-ls/builtins/diagnostics/stylelint.lua
@@ -18,7 +18,7 @@ return h.make_builtin({
         to_stdin = true,
         format = "json_raw",
         from_stderr = true,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         on_output = function(params)
             local output = params.output and params.output[1] and params.output[1].warnings or {}
 
diff --git a/lua/null-ls/builtins/diagnostics/stylint.lua b/lua/null-ls/builtins/diagnostics/stylint.lua
@@ -28,7 +28,7 @@ return h.make_builtin({
                 groups = { "row", "col", "severity", "message" },
             },
         }),
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
     },
     factory = h.generator_factory,
 })
diff --git a/lua/null-ls/builtins/formatting/eslint.lua b/lua/null-ls/builtins/formatting/eslint.lua
@@ -42,7 +42,7 @@ return h.make_builtin({
                     },
                 }
         end,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         check_exit_code = { 0, 1 },
         cwd = h.cache.by_bufnr(function(params)
             return u.root_pattern(
diff --git a/lua/null-ls/builtins/formatting/prettier.lua b/lua/null-ls/builtins/formatting/prettier.lua
@@ -41,7 +41,7 @@ return h.make_builtin({
             "$FILENAME",
         }, "--range-start", "--range-end", { row_offset = -1, col_offset = -1 }),
         to_stdin = true,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         cwd = h.cache.by_bufnr(function(params)
             return u.root_pattern(
                 -- https://prettier.io/docs/en/configuration.html
diff --git a/lua/null-ls/builtins/formatting/prettier_d_slim.lua b/lua/null-ls/builtins/formatting/prettier_d_slim.lua
@@ -43,7 +43,7 @@ return h.make_builtin({
             { row_offset = -1, col_offset = -1 }
         ),
         to_stdin = true,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         cwd = h.cache.by_bufnr(function(params)
             return u.root_pattern(
                 -- https://prettier.io/docs/en/configuration.html
diff --git a/lua/null-ls/builtins/formatting/prettier_standard.lua b/lua/null-ls/builtins/formatting/prettier_standard.lua
@@ -17,7 +17,7 @@ return h.make_builtin({
         command = "prettier-standard",
         args = { "--stdin" },
         to_stdin = true,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         cwd = h.cache.by_bufnr(function(params)
             return u.root_pattern(
                 -- https://prettier.io/docs/en/configuration.html
diff --git a/lua/null-ls/builtins/formatting/prettierd.lua b/lua/null-ls/builtins/formatting/prettierd.lua
@@ -32,7 +32,7 @@ return h.make_builtin({
     generator_opts = {
         command = "prettierd",
         args = { "$FILENAME" },
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         to_stdin = true,
         cwd = h.cache.by_bufnr(function(params)
             return u.root_pattern(
diff --git a/lua/null-ls/builtins/formatting/rescript.lua b/lua/null-ls/builtins/formatting/rescript.lua
@@ -19,7 +19,7 @@ return h.make_builtin({
         args = function(params)
             return { "format", "-stdin", "." .. vim.fn.fnamemodify(params.bufname, ":e") }
         end,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
         to_stdin = true,
     },
     factory = h.formatter_factory,
diff --git a/lua/null-ls/builtins/formatting/rustywind.lua b/lua/null-ls/builtins/formatting/rustywind.lua
@@ -24,7 +24,7 @@ return h.make_builtin({
         command = "rustywind",
         args = { "--stdin" },
         to_stdin = true,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
     },
     factory = h.formatter_factory,
 })
diff --git a/lua/null-ls/builtins/formatting/standardjs.lua b/lua/null-ls/builtins/formatting/standardjs.lua
@@ -16,7 +16,7 @@ return h.make_builtin({
         command = "standard",
         args = { "--stdin", "--fix" },
         to_stdin = true,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
     },
     factory = h.formatter_factory,
 })
diff --git a/lua/null-ls/builtins/formatting/stylelint.lua b/lua/null-ls/builtins/formatting/stylelint.lua
@@ -17,7 +17,7 @@ return h.make_builtin({
         args = { "--fix", "--stdin", "--stdin-filename", "$FILENAME" },
         to_stdin = true,
         from_stderr = true,
-        dynamic_command = cmd_resolver.from_node_modules,
+        dynamic_command = cmd_resolver.from_node_modules(),
     },
     factory = h.formatter_factory,
 })
diff --git a/lua/null-ls/helpers/command_resolver.lua b/lua/null-ls/helpers/command_resolver.lua
@@ -27,7 +27,7 @@ end
 
 --- creates a resolver that searches for a local executable and caches results by bufnr
 ---@param prefix string|nil
-M.make_generic_resolver = function(prefix)
+M.generic = function(prefix)
     ---@param params NullLsParams
     ---@return string|nil
     return cache.by_bufnr(function(params)
@@ -41,42 +41,44 @@ M.make_generic_resolver = function(prefix)
     end)
 end
 
-local node_modules_resolver = M.make_generic_resolver(u.path.join("node_modules", ".bin"))
---- resolver that searches for a local node_modules executable and falls back to a global executable
-M.from_node_modules = function(params)
-    return node_modules_resolver(params) or params.command
+--- creates a resolver that searches for a local node_modules executable and falls back to a global executable
+M.from_node_modules = function()
+    local node_modules_resolver = M.generic(u.path.join("node_modules", ".bin"))
+    return function(params)
+        return node_modules_resolver(params) or params.command
+    end
 end
 
---- resolver that searches for a local yarn pnp executable and falls back to a global executable
----@param params NullLsParams
----@return string|string[]|nil
-M.from_yarn_pnp = cache.by_bufnr(function(params)
-    local ok, yarn_command = pcall(function()
-        local root = params.root
-        if not root then
-            error("unable to resolve root directory")
-        end
+--- creates a resolver that searches for a local yarn pnp executable and falls back to a global executable
+M.from_yarn_pnp = function()
+    return cache.by_bufnr(function(params)
+        local ok, yarn_command = pcall(function()
+            local root = params.root
+            if not root then
+                error("unable to resolve root directory")
+            end
 
-        -- older yarn versions use `.pnp.js`, so look for both new and old names
-        local pnp_executable, pnp_dir = search_ancestors_for_executable(params.bufname, root, ".pnp.cjs")
-        if not (pnp_executable and pnp_dir) then
-            pnp_executable, pnp_dir = search_ancestors_for_executable(params.bufname, root, ".pnp.js")
-        end
-        if not (pnp_executable and pnp_dir) then
-            error("failed to find yarn executable")
-        end
+            -- older yarn versions use `.pnp.js`, so look for both new and old names
+            local pnp_executable, pnp_dir = search_ancestors_for_executable(params.bufname, root, ".pnp.cjs")
+            if not (pnp_executable and pnp_dir) then
+                pnp_executable, pnp_dir = search_ancestors_for_executable(params.bufname, root, ".pnp.js")
+            end
+            if not (pnp_executable and pnp_dir) then
+                error("failed to find yarn executable")
+            end
 
-        local yarn_bin_cmd =
-            string.format("cd %s && yarn bin %s", vim.fn.shellescape(pnp_dir), vim.fn.shellescape(params.command))
-        local yarn_bin = vim.fn.system(yarn_bin_cmd):gsub("%s+", "")
-        if vim.v.shell_error ~= 0 then
-            error("failed to get yarn bin")
-        end
+            local yarn_bin_cmd =
+                string.format("cd %s && yarn bin %s", vim.fn.shellescape(pnp_dir), vim.fn.shellescape(params.command))
+            local yarn_bin = vim.fn.system(yarn_bin_cmd):gsub("%s+", "")
+            if vim.v.shell_error ~= 0 then
+                error("failed to get yarn bin")
+            end
 
-        return { "node", "--require", pnp_executable, yarn_bin }
-    end)
+            return { "node", "--require", pnp_executable, yarn_bin }
+        end)
 
-    return ok and yarn_command or params.command
-end)
+        return ok and yarn_command or params.command
+    end)
+end
 
 return M
diff --git a/lua/null-ls/helpers/make_builtin.lua b/lua/null-ls/helpers/make_builtin.lua
@@ -81,7 +81,7 @@ local function make_builtin(opts)
     if prefer_local or only_local then
         local maybe_prefix = prefer_local or only_local
         local prefix = type(maybe_prefix) == "string" and maybe_prefix or nil
-        local resolver = cmd_resolver.make_generic_resolver(prefix)
+        local resolver = cmd_resolver.generic(prefix)
 
         generator_opts.dynamic_command = function(params)
             local resolved_command = resolver(params) or (prefer_local and params.command)

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ return h.make_builtin({`
`42`	`42`	`},`
`43`	`43`	`}`
`44`	`44`	`end,`
`45`		`- dynamic_command = cmd_resolver.from_node_modules,`
	`45`	`+ dynamic_command = cmd_resolver.from_node_modules(),`
`46`	`46`	`check_exit_code = { 0, 1 },`
`47`	`47`	`cwd = h.cache.by_bufnr(function(params)`
`48`	`48`	`return u.root_pattern(`