feat(format): new LazyVim formatter with integrations for lsp/none-ls/conform/eslint/...

lua/lazyvim/plugins/lsp/format.lua

@@ -1,126 +0,0 @@
-local Util = require("lazy.core.util")
-
-local M = {}
-
----@type PluginLspOpts
-M.opts = nil
-
--- Allow plugins to set a custom formatter for a buffer.
--- See the conform extra for an example.
----@type fun(bufnr:number):boolean
-M.custom_format = nil
-
-function M.enabled()
-  return M.opts.autoformat
-end
-
-function M.toggle()
-  if vim.b.autoformat == false then
-    vim.b.autoformat = nil
-    M.opts.autoformat = true
-  else
-    M.opts.autoformat = not M.opts.autoformat
-  end
-  if M.opts.autoformat then
-    Util.info("Enabled format on save", { title = "Format" })
-  else
-    Util.warn("Disabled format on save", { title = "Format" })
-  end
-end
-
----@param opts? {force?:boolean}
-function M.format(opts)
-  local buf = vim.api.nvim_get_current_buf()
-  if vim.b.autoformat == false and not (opts and opts.force) then
-    return
-  end
-
-  if
-    M.custom_format
-    and Util.try(function()
-      return M.custom_format(buf)
-    end, { msg = "Custom formatter failed" })
-  then
-    return
-  end
-
-  local formatters = M.get_formatters(buf)
-  local client_ids = vim.tbl_map(function(client)
-    return client.id
-  end, formatters.active)
-
-  if #client_ids == 0 then
-    if opts and opts.force then
-      Util.warn("No formatter available", { title = "LazyVim" })
-    end
-    return
-  end
-
-  vim.lsp.buf.format(vim.tbl_deep_extend("force", {
-    bufnr = buf,
-    filter = function(client)
-      return vim.tbl_contains(client_ids, client.id)
-    end,
-  }, require("lazyvim.util").opts("nvim-lspconfig").format or {}))
-end
-
--- Gets all lsp clients that support formatting.
--- When a null-ls formatter is available for the current filetype,
--- only null-ls formatters are returned.
-function M.get_formatters(bufnr)
-  local ft = vim.bo[bufnr].filetype
-  -- check if we have any null-ls formatters for the current filetype
-  local null_ls = package.loaded["null-ls"] and require("null-ls.sources").get_available(ft, "NULL_LS_FORMATTING") or {}
-
-  ---@class LazyVimFormatters
-  local ret = {
-    ---@type lsp.Client[]
-    active = {},
-    ---@type lsp.Client[]
-    available = {},
-    null_ls = null_ls,
-  }
-
-  ---@type lsp.Client[]
-  local clients = require("lazyvim.util").get_clients({ bufnr = bufnr })
-  for _, client in ipairs(clients) do
-    if M.supports_format(client) then
-      if (#null_ls > 0 and client.name == "null-ls") or #null_ls == 0 then
-        table.insert(ret.active, client)
-      else
-        table.insert(ret.available, client)
-      end
-    end
-  end
-
-  return ret
-end
-
--- Gets all lsp clients that support formatting
--- and have not disabled it in their client config
----@param client lsp.Client
-function M.supports_format(client)
-  if
-    client.config
-    and client.config.capabilities
-    and client.config.capabilities.documentFormattingProvider == false
-  then
-    return false
-  end
-  return client.supports_method("textDocument/formatting") or client.supports_method("textDocument/rangeFormatting")
-end
-
----@param opts PluginLspOpts
-function M.setup(opts)
-  M.opts = opts
-  vim.api.nvim_create_autocmd("BufWritePre", {
-    group = vim.api.nvim_create_augroup("LazyVimFormat", {}),
-    callback = function()
-      if M.opts.autoformat then
-        M.format()
-      end
-    end,
-  })
-end
-
-return M

lua/lazyvim/plugins/lsp/init.lua

@@ -35,8 +35,6 @@ return {
       },
       -- add any global capabilities here
       capabilities = {},
-      -- Automatically format on save
-      autoformat = true,
       -- options for vim.lsp.buf.format
       -- `bufnr` and `filter` is handled by the LazyVim formatter,
       -- but can be also overridden when specified
@@ -80,16 +78,20 @@ return {
     },
     ---@param opts PluginLspOpts
     config = function(_, opts)
-      local Util = require("lazyvim.util")
-
       if Util.has("neoconf.nvim") then
         local plugin = require("lazy.core.config").spec.plugins["neoconf.nvim"]
         require("neoconf").setup(require("lazy.core.plugin").values(plugin, "opts", false))
       end
+
       -- setup autoformat
-      require("lazyvim.plugins.lsp.format").setup(opts)
-      -- setup formatting and keymaps
-      Util.on_attach(function(client, buffer)
+      Util.format.register(Util.lsp.formatter())
+
+      -- deprectaed options
+      if opts.autoformat ~= nil then
+        vim.g.autoformat = opts.autoformat
+        Util.deprecate("nvim-lspconfig.opts.autoformat", "vim.g.autoformat")
+      end
+
       -- setup keymaps
       Util.lsp.on_attach(function(client, buffer)
         require("lazyvim.plugins.lsp.keymaps").on_attach(client, buffer)
@@ -215,6 +217,30 @@ return {
         },
       }
     end,
+    config = function(_, opts)
+      require("null-ls").setup(opts)
+
+      -- register the formatter with LazyVim
+      require("lazyvim.util").format.register({
+        name = "none-ls.nvim",
+        priority = 50,
+        primary = true,
+        format = function(buf)
+          return Util.lsp.format({
+            bufnr = buf,
+            filter = function(client)
+              return client.name == "null-ls"
+            end,
+          })
+        end,
+        sources = function(buf)
+          local ret = require("null-ls.sources").get_available(vim.bo[buf].filetype, "NULL_LS_FORMATTING") or {}
+          return vim.tbl_map(function(source)
+            return source.name
+          end, ret)
+        end,
+      })
+    end,
   },
 
   -- cmdline tools and lsp servers