feat: automatically detect config module changes in or oustside Neovim and reload

Author: folke

README.md

@@ -29,19 +29,19 @@
   - [ ] other package manager artifacts still present? compiled etc
 - [x] rename `run` to `build`
 - [ ] delete lazy keymaps when a plugin loads
-- [ ] temp colorscheme
-- [x] allow setting up plugins through config
+- [x] temp colorscheme
+- [x] allow setting up plugins through config **fooo**
 - [x] task timeout
 - [ ] log file
 - [ ] deal with re-sourcing init.lua. Check a global?
 - [x] incorrect when switching TN from opt to start
 - [ ] git tests
 - [x] max concurrency
 - [x] ui border
-- [ ] make sure we can reload specs while keeping state
+- [x] make sure we can reload specs while keeping state
 - [ ] show disabled plugins (strikethrough?)
 - [ ] Import specs from other plugin managers
-- [ ] use uv file watcher (or stat) to check for config changes
+- [x] use uv file watcher (or stat) to check for config changes
 - [ ] [packspec](https://github.com/nvim-lua/nvim-package-specification)
   - [ ] add support to specify `engines`, `os` and `cpu` like in `package.json`
   - [ ] semver merging. Should check if two or more semver ranges are compatible and calculate the union range

lua/lazy/core/config.lua

@@ -33,7 +33,7 @@ M.defaults = {
     -- install missing plugins on startup. This doesn't increase startup time.
     missing = true,
     -- try to load one of the colorschemes in this list when starting an install during startup
-    -- the first colorscheme that is found will be used
+    -- the first colorscheme that is found will be loaded
     colorscheme = { "habamax" },
   },
   ui = {
@@ -100,6 +100,7 @@ function M.setup(spec, opts)
     callback = function()
       require("lazy.core.cache").autosave()
       require("lazy.view").setup()
+      require("lazy.manage.reloader").enable()
     end,
   })
 

lua/lazy/core/handler.lua

@@ -63,7 +63,9 @@ function M.trigger(groups, events, pattern)
           end
           Util.info(lines)
         end
-        vim.api.nvim_exec_autocmds(autocmd.event, { group = autocmd.group, modeline = false })
+        Util.try(function()
+          vim.api.nvim_exec_autocmds(autocmd.event, { group = autocmd.group, modeline = false })
+        end)
       end
     end
   end

lua/lazy/core/plugin.lua

@@ -195,6 +195,8 @@ function M.spec()
     -- spec is a module
     local function _load(name)
       local modname = name and (Config.spec .. "." .. name) or Config.spec
+      -- unload the module so we get a clean slate
+      ---@diagnostic disable-next-line: no-unknown
       package.loaded[modname] = nil
       Util.try(function()
         spec:normalize(require(modname))

lua/lazy/manage/init.lua

@@ -115,15 +115,14 @@ end
 
 ---@param opts? ManagerOpts
 function M.clean(opts)
-  Plugin.update_state()
   M.run({
     pipeline = { "fs.clean" },
     plugins = Config.to_clean,
   }, opts)
 end
 
 function M.clear()
-  Plugin.update_state()
+  Plugin.load()
   for _, plugin in pairs(Config.plugins) do
     plugin._.updated = nil
     plugin._.cloned = nil

lua/lazy/manage/reloader.lua

@@ -0,0 +1,82 @@
+local Cache = require("lazy.core.cache")
+local Config = require("lazy.core.config")
+local Util = require("lazy.util")
+local Plugin = require("lazy.core.plugin")
+
+local M = {}
+
+---@type table<string, CacheHash>
+M.files = {}
+
+---@type vim.loop.Timer
+M.timer = nil
+M.main = nil
+M.root = nil
+
+function M.enable()
+  if M.timer then
+    M.timer:stop()
+  end
+  if type(Config.spec) == "string" then
+    M.timer = vim.loop.new_timer()
+    M.root = vim.fn.stdpath("config") .. "/lua/" .. Config.spec:gsub("%.", "/")
+    M.main = vim.loop.fs_stat(M.root .. ".lua") and (M.root .. ".lua") or (M.root .. "/init.lua")
+    M.check(true)
+    M.timer:start(2000, 2000, M.check)
+  end
+end
+
+function M.disable()
+  if M.timer then
+    M.timer:stop()
+    M.timer = nil
+  end
+end
+
+function M.check(start)
+  ---@type table<string,true>
+  local checked = {}
+  ---@type {file:string, what:string}[]
+  local changes = {}
+
+  -- spec is a module
+  local function check(_, modpath)
+    checked[modpath] = true
+    local hash = Cache.hash(modpath)
+    if hash then
+      if M.files[modpath] then
+        if not Cache.eq(M.files[modpath], hash) then
+          M.files[modpath] = hash
+          table.insert(changes, { file = modpath, what = "changed" })
+        end
+      else
+        M.files[modpath] = hash
+        table.insert(changes, { file = modpath, what = "added" })
+      end
+    end
+  end
+
+  check(nil, M.main)
+  Util.lsmod(M.root, check)
+
+  for file in pairs(M.files) do
+    if not checked[file] then
+      table.insert(changes, { file = file, what = "deleted" })
+      M.files[file] = nil
+    end
+  end
+
+  if not (start or #changes == 0) then
+    vim.schedule(function()
+      local lines = { "# Config Change Detected. Reloading...", "" }
+      for _, change in ipairs(changes) do
+        table.insert(lines, "- **" .. change.what .. "**: `" .. vim.fn.fnamemodify(change.file, ":p:~:.") .. "`")
+      end
+      Util.warn(lines)
+      Plugin.load()
+      vim.cmd([[do User LazyRender]])
+    end)
+  end
+end
+
+return M