refactor: modularise inter-plugin integrations (mostly snacks)

SystematicError · SystematicError · commit 836c471ba4e9 · 2025-09-06T12:18:28.000Z
diff --git a/lua/plugins/conform.lua b/lua/plugins/conform.lua
@@ -1,66 +1,8 @@
--- TODO: Refine config
--- TODO: Modularise snacks integration
 -- TODO: Lazy load conform
 
-local default_opts = {
-    format_on_save = function(bufnr)
-        local global_state = vim.g.format_on_save
-        local buffer_state = vim.b[bufnr].format_on_save
-
-        local state = global_state == nil or global_state
-
-        if buffer_state ~= nil then
-            state = buffer_state
-        end
-
-        return state and {
-            timeout_ms = 1000,
-            lsp_format = "fallback",
-        }
-    end,
-}
-
-local function config(_, opts)
-    vim.g.format_on_save = true
-
-    if Snacks then
-        Snacks.toggle({
-            name = "Formatter (Global)",
-            get = function()
-                return vim.g.format_on_save == nil or vim.g.format_on_save
-            end,
-            set = function(state)
-                vim.g.format_on_save = state
-                vim.b.format_on_save = nil
-            end,
-        }):map "<leader>ulf"
-
-        Snacks.toggle({
-            name = "Formatter (Buffer)",
-            get = function()
-                local global_state = vim.g.format_on_save
-                local buffer_state = vim.b[vim.api.nvim_get_current_buf()].format_on_save
-
-                if buffer_state ~= nil then
-                    return buffer_state
-                end
-
-                return global_state == nil or global_state
-            end,
-            set = function(state)
-                vim.b.format_on_save = state
-            end,
-        }):map "<leader>ulF"
-    end
-
-    require("conform").setup(opts)
-end
-
+-- Config function defined in `plugins/snacks.lua`
 return {
     "stevearc/conform.nvim",
-
     lazy = false,
-
-    opts = default_opts,
-    config = config,
+    opts = {},
 }
diff --git a/lua/plugins/gitsigns.lua b/lua/plugins/gitsigns.lua
@@ -1,5 +1,4 @@
 -- TODO: Lazy load gitsigns
--- TODO: Modularise snacks integration
 
 local default_opts = {
     signs = {},
@@ -11,26 +10,7 @@ for name, sign in pairs(require("icons").git_gutter) do
     default_opts.signs[name] = { text = sign }
 end
 
-local function config(_, opts)
-    local gitsigns = require "gitsigns"
-
-    if Snacks then
-        local gitsigns_config = require("gitsigns.config").config
-
-        Snacks.toggle({
-            name = "Git Line Blame",
-            get = function()
-                return gitsigns_config.current_line_blame
-            end,
-            set = function(state)
-                gitsigns.toggle_current_line_blame(state)
-            end,
-        }):map "<leader>ug"
-    end
-
-    gitsigns.setup(opts)
-end
-
+-- Config function defined in `plugins/snacks.lua`
 return {
     "lewis6991/gitsigns.nvim",
 
@@ -52,7 +32,6 @@ return {
     },
 
     opts = default_opts,
-    config = config,
 
     specs = {
         "catppuccin/nvim",
diff --git a/lua/plugins/lightbulb.lua b/lua/plugins/lightbulb.lua
@@ -1,4 +1,3 @@
--- TODO: Modularise snacks integration
 -- TODO: Lazy load lightbulb
 
 local bulb_icons = require("icons").lightbulb
@@ -22,29 +21,9 @@ local default_opts = {
     end,
 }
 
-local function config(_, opts)
-    vim.g.enable_lightbulb = true
-
-    if Snacks then
-        Snacks.toggle({
-            name = "Lightbulb",
-            get = function()
-                return vim.g.enable_lightbulb
-            end,
-            set = function(state)
-                vim.g.enable_lightbulb = state
-            end,
-        }):map "<leader>ull"
-    end
-
-    require("nvim-lightbulb").setup(opts)
-end
-
+-- Config function defined in `plugins/snacks.lua`
 return {
     "kosayoda/nvim-lightbulb",
-
     lazy = false,
-
     opts = default_opts,
-    config = config,
 }
diff --git a/lua/plugins/lspconfig.lua b/lua/plugins/lspconfig.lua
@@ -1,5 +1,4 @@
 -- TODO: Lazy load lspconfig
--- TODO: Modularise snacks integration
 
 local default_opts = {
     servers = {},
@@ -51,17 +50,10 @@ local function config(_, opts)
     })
 
     if Snacks then
-        Snacks.toggle.diagnostics({ name = "Diagnostics (Global)" }):map "<leader>uld"
-        Snacks.toggle({
-            name = "Diagnostics (Buffer)",
-            get = function()
-                return vim.diagnostic.is_enabled { bufnr = 0 }
-            end,
-            set = function(state)
-                vim.diagnostic.enable(state, { bufnr = 0 })
-            end,
-        }):map "<leader>ulD"
+        Snacks.toggle.diagnostics():map "<leader>uld"
 
+        -- HACK: Snacks.toggle.inlay_hint (exceptionally) only toggles locally
+        -- TODO: Upstream snacks inlay_hint toggle?
         Snacks.toggle({
             name = "Inlay Hints",
             get = function()
diff --git a/lua/plugins/neo-tree.lua b/lua/plugins/neo-tree.lua
@@ -1,6 +1,3 @@
--- TODO: Modularise snacks integration
--- TODO: Improve neo-tree config
-
 local icons = require "icons"
 
 local default_opts = {
@@ -39,25 +36,7 @@ local default_opts = {
     },
 }
 
-local function config(_, opts)
-    if Snacks then
-        local events = require "neo-tree.events"
-
-        local function on_move(data)
-            Snacks.rename.on_rename_file(data.source, data.destination)
-        end
-
-        opts.event_handlers = opts.event_handlers or {}
-
-        vim.list_extend(opts.event_handlers, {
-            { event = events.FILE_MOVED, handler = on_move },
-            { event = events.FILE_RENAMED, handler = on_move },
-        })
-    end
-
-    require("neo-tree").setup(opts)
-end
-
+-- Config function defined in `plugins/snacks.lua`
 return {
     "nvim-neo-tree/neo-tree.nvim",
     dependencies = {
@@ -86,15 +65,32 @@ return {
     end,
 
     opts = default_opts,
-    config = config,
 
     specs = {
-        "catppuccin/nvim",
-        optional = true,
-        opts = {
-            integrations = {
-                neotree = true,
+        {
+            "catppuccin/nvim",
+            optional = true,
+            opts = {
+                integrations = {
+                    neotree = true,
+                },
             },
         },
+
+        {
+            "NeogitOrg/neogit",
+            optional = true,
+            config = function()
+                vim.api.nvim_create_autocmd("BufWinLeave", {
+                    pattern = "NeogitStatus",
+                    group = vim.api.nvim_create_augroup("frosty_neotree_git_update", { clear = true }),
+                    desc = "Update neotree's git icons after neogit updates its status",
+                    callback = function()
+                        local events = require "neo-tree.events"
+                        events.fire_event(events.GIT_EVENT)
+                    end,
+                })
+            end,
+        },
     },
 }
diff --git a/lua/plugins/neogit.lua b/lua/plugins/neogit.lua
@@ -6,6 +6,7 @@ local default_opts = {
     },
 }
 
+-- Config function defined in `plugins/neo-tree.lua`
 return {
     "NeogitOrg/neogit",
     dependencies = {
diff --git a/lua/plugins/snacks.lua b/lua/plugins/snacks.lua
@@ -1,5 +1,3 @@
--- TODO: Modularise opts table
-
 local function config()
     -- TODO: Are all these enabled lines needed?
     local opts = {
@@ -24,10 +22,9 @@ local function config()
         },
     }
 
-    -- BUG: Wrap option being applied globally
     Snacks.toggle.option("wrap", { name = "Line Wrap", global = true }):map "<leader>uw"
 
-    -- TODO: Better way to rename snack toggles
+    -- HACK: Equivalent to `Snacks.toggle.words` but renamed
     Snacks.toggle({
         name = "References",
         get = function()
@@ -72,7 +69,20 @@ return {
 
     config = config,
 
+    -- Some snacks dependent integrations are defined in the respective plugins' config functions
+    -- Search for `if Snacks then` to find these
     specs = {
+        {
+            "akinsho/bufferline.nvim",
+            optional = true,
+            opts = {
+                options = {
+                    close_command = "lua Snacks.bufdelete.delete(%d)",
+                    right_mouse_command = "lua Snacks.bufdelete.delete(%d)",
+                },
+            },
+        },
+
         {
             "catppuccin/nvim",
             optional = true,
@@ -84,14 +94,96 @@ return {
         },
 
         {
-            "akinsho/bufferline.nvim",
+            "stevearc/conform.nvim",
             optional = true,
+
             opts = {
-                options = {
-                    close_command = "lua Snacks.bufdelete.delete(%d)",
-                    right_mouse_command = "lua Snacks.bufdelete.delete(%d)",
-                },
+                format_on_save = function()
+                    return vim.g.format_on_save
+                        and {
+                            timeout_ms = 1000,
+                            lsp_format = "fallback",
+                        }
+                end,
             },
+
+            config = function(_, opts)
+                vim.g.format_on_save = true
+
+                Snacks.toggle({
+                    name = "Formatter",
+                    get = function()
+                        return vim.g.format_on_save
+                    end,
+                    set = function(state)
+                        vim.g.format_on_save = state
+                    end,
+                }):map "<leader>ulf"
+
+                require("conform").setup(opts)
+            end,
+        },
+
+        {
+            "lewis6991/gitsigns.nvim",
+            optional = true,
+            config = function(_, opts)
+                local gitsigns = require "gitsigns"
+                local gitsigns_config = require("gitsigns.config").config
+
+                Snacks.toggle({
+                    name = "Git Line Blame",
+                    get = function()
+                        return gitsigns_config.current_line_blame
+                    end,
+                    set = function(state)
+                        gitsigns.toggle_current_line_blame(state)
+                    end,
+                }):map "<leader>ug"
+
+                gitsigns.setup(opts)
+            end,
+        },
+
+        {
+            "kosayoda/nvim-lightbulb",
+            optional = true,
+            config = function(_, opts)
+                vim.g.enable_lightbulb = true
+
+                Snacks.toggle({
+                    name = "Lightbulb",
+                    get = function()
+                        return vim.g.enable_lightbulb
+                    end,
+                    set = function(state)
+                        vim.g.enable_lightbulb = state
+                    end,
+                }):map "<leader>ull"
+
+                require("nvim-lightbulb").setup(opts)
+            end,
+        },
+
+        {
+            "nvim-neo-tree/neo-tree.nvim",
+            optional = true,
+            config = function(_, opts)
+                local events = require "neo-tree.events"
+
+                local function on_move(data)
+                    Snacks.rename.on_rename_file(data.source, data.destination)
+                end
+
+                opts.event_handlers = opts.event_handlers or {}
+
+                vim.list_extend(opts.event_handlers, {
+                    { event = events.FILE_MOVED, handler = on_move },
+                    { event = events.FILE_RENAMED, handler = on_move },
+                })
+
+                require("neo-tree").setup(opts)
+            end,
         },
     },
 }
diff --git a/lua/plugins/which-key.lua b/lua/plugins/which-key.lua

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ local default_opts = {`
`6`	`6`	`},`
`7`	`7`	`}`
`8`	`8`
	`9`	+-- Config function defined in `plugins/neo-tree.lua`
`9`	`10`	`return {`
`10`	`11`	`"NeogitOrg/neogit",`
`11`	`12`	`dependencies = {`