refactor!: remove autoformat from features table and only configure through formatting table

Author: mehalter

lua/astrolsp/config.lua

@@ -13,7 +13,6 @@
 ---@field cond boolean|function|string? condition for the mapping
 
 ---@class AstroLSPFeatureOpts
----@field autoformat boolean? enable or disable auto formatting on start (boolean' default = true)
 ---@field codelens boolean? enable/disable codelens refresh on start (boolean; default = true)
 ---@field diagnostics_mode integer? diagnostic mode on start (0 = off, 1 = no signs/virtual text, 2 = no virtual text, 3 = off; default = 3)
 ---@field inlay_hints boolean? enable/disable inlay hints on start (boolean; default = false)
@@ -38,7 +37,6 @@
 --
 ---```lua
 ---features = {
----  autoformat = true,
 ---  codelens = true,
 ---  diagnostics_mode = 3,
 ---  inlay_hints = false,
@@ -202,7 +200,6 @@
 ---@type AstroLSPOpts
 local M = {
   features = {
-    autoformat = true,
     codelens = true,
     diagnostics_mode = 3,
     inlay_hints = false,

lua/astrolsp/init.lua

@@ -265,6 +265,11 @@ function M.setup(opts)
 
   setup_diagnostics()
 
+  -- normalize format_on_save to table format
+  if vim.tbl_get(M.config, "formatting", "format_on_save") == false then
+    M.config.formatting.format_on_save = { enabled = false }
+  end
+
   --- Format options that are passed into the `vim.lsp.buf.format` (`:h vim.lsp.buf.format()`)
   ---@type AstroLSPFormatOpts
   M.format_opts = vim.deepcopy(assert(M.config.formatting))

lua/astrolsp/toggles.lua

@@ -9,16 +9,18 @@
 ---@class astrolsp.toggles
 local M = {}
 
-local features = require("astrolsp").config.features --[[@as AstroLSPFeatureOpts]]
+local config = require("astrolsp").config
+local features = config.features --[[@as AstroLSPFeatureOpts]]
+local format_on_save = config.formatting.format_on_save --[[@as AstroLSPFormatOnSaveOpts]]
 
 local function ui_notify(silent, ...) return not silent and vim.notify(...) end
 local function bool2str(bool) return bool and "on" or "off" end
 
 --- Toggle auto format
 ---@param silent? boolean if true then don't sent a notification
 function M.autoformat(silent)
-  features.autoformat = not features.autoformat
-  ui_notify(silent, ("Global autoformatting %s"):format(bool2str(features.autoformat)))
+  format_on_save.enabled = not format_on_save.enabled
+  ui_notify(silent, ("Global autoformatting %s"):format(bool2str(format_on_save.enabled)))
 end
 
 --- Toggle buffer local auto format
@@ -27,7 +29,10 @@ end
 function M.buffer_autoformat(bufnr, silent)
   bufnr = bufnr or 0
   local old_val = vim.b[bufnr].autoformat
-  if old_val == nil then old_val = features.autoformat end
+  if old_val == nil then
+    ui_notify(silent, "No LSP attached with auto formatting")
+    return
+  end
   vim.b[bufnr].autoformat = not old_val
   ui_notify(silent, ("Buffer autoformatting %s"):format(bool2str(vim.b[bufnr].autoformat)))
 end