Skip to content

Commit

Permalink
feat: lazy setup with either a plugins module, or a plugins spec
Browse files Browse the repository at this point in the history
  • Loading branch information
folke committed Dec 1, 2022
1 parent f0894be commit af8b8e1
Show file tree
Hide file tree
Showing 8 changed files with 54 additions and 53 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
- [ ] health checks: check merge conflicts async
- [ ] unsupported props or props from other managers
- [x] rename `run` to `build`
- [ ] allow setting up plugins through config
- [ ] delete lazy keymaps when a plugin loads
- [x] allow setting up plugins through config
- [x] task timeout
- [ ] log file
- [ ] deal with re-sourcing init.lua. Check a global?
Expand Down Expand Up @@ -67,6 +68,7 @@
- `requires` => `dependencies`
- `as` => `name`
- `opt` => `lazy`
- `run` => `build`

## 📦 Other Neovim Plugin Managers in Lua

Expand Down
22 changes: 9 additions & 13 deletions lua/lazy/core/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ local M = {}

---@class LazyConfig
M.defaults = {
plugins = "config.plugins",
defaults = {
lazy = false, -- should plugins be loaded at startup?
version = nil,
Expand Down Expand Up @@ -52,14 +51,11 @@ M.defaults = {

M.ns = vim.api.nvim_create_namespace("lazy")

M.paths = {
---@type string
opt = nil,
---@type string
main = nil,
---@type string
plugins = nil,
}
---@type string|LazySpec Should be either a string pointing to a module, or a spec
M.spec = nil

---@type string Opt directory where plugins will be installed
M.root = nil

---@type table<string, LazyPlugin>
M.plugins = {}
Expand All @@ -70,12 +66,12 @@ M.to_clean = {}
---@type LazyConfig
M.options = {}

---@param spec LazySpec
---@param opts? LazyConfig
function M.setup(opts)
function M.setup(spec, opts)
M.spec = spec
M.options = vim.tbl_deep_extend("force", M.defaults, opts or {})
M.paths.plugins = vim.fn.stdpath("config") .. "/lua/" .. M.options.plugins:gsub("%.", "/")
M.paths.main = M.paths.plugins .. (vim.loop.fs_stat(M.paths.plugins .. ".lua") and ".lua" or "/init.lua")
M.paths.opt = M.options.package.path .. "/pack/" .. M.options.package.name .. "/opt"
M.root = M.options.package.path .. "/pack/" .. M.options.package.name .. "/opt"

if M.options.package.reset then
vim.go.packpath = M.options.package.path
Expand Down
1 change: 1 addition & 0 deletions lua/lazy/core/handler.lua
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ function M.handlers.module(grouped)
if plugins then
grouped[name] = nil
local reason = { require = modname }
-- almost never happens, so this does not decrease performance
if #Loader.loading == 0 then
local f = 3
while not reason.source do
Expand Down
16 changes: 16 additions & 0 deletions lua/lazy/core/loader.lua
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,24 @@ local M = {}
M.loading = {}

function M.setup()
-- install missing plugins
if Config.options.install_missing then
Util.track("install")
for _, plugin in pairs(Config.plugins) do
if not plugin._.installed then
vim.cmd("do User LazyInstallPre")
require("lazy.manage").install({ wait = true })
break
end
end
Util.track()
end

-- setup handlers
Util.track("handlers")
local Handler = require("lazy.core.handler")
Handler.setup()
Util.track()
end

function M.init_plugins()
Expand Down
30 changes: 19 additions & 11 deletions lua/lazy/core/plugin.lua
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ end
function M.update_state()
---@type table<string,FileType>
local installed = {}
Util.ls(Config.paths.opt, function(_, name, type)
Util.ls(Config.root, function(_, name, type)
if type == "directory" or type == "link" then
installed[name] = type
end
Expand All @@ -165,7 +165,7 @@ function M.update_state()
or plugin.cmd
plugin.lazy = lazy and true or false
end
plugin.dir = Config.paths.opt .. "/" .. plugin.name
plugin.dir = Config.root .. "/" .. plugin.name
plugin._.is_local = plugin.uri:sub(1, 4) ~= "http" and plugin.uri:sub(1, 3) ~= "git"
plugin._.is_symlink = installed[plugin.name] == "link"
plugin._.installed = installed[plugin.name] ~= nil
Expand All @@ -178,7 +178,7 @@ function M.update_state()
for pack, dir_type in pairs(installed) do
table.insert(Config.to_clean, {
name = pack,
dir = Config.paths.opt .. "/" .. pack,
dir = Config.root .. "/" .. pack,
_ = {
installed = true,
is_symlink = dir_type == "link",
Expand All @@ -191,15 +191,23 @@ end
function M.spec()
local spec = Spec.new()

local function _load(name, modpath)
local modname = Config.options.plugins .. (name and ("." .. name) or "")
Util.try(function()
spec:normalize(Module.load(modname, modpath))
end, "Failed to load **" .. modname .. "**")
if type(Config.spec) == "string" then
-- spec is a module
local function _load(name, modpath)
local modname = Config.spec .. (name and ("." .. name) or "")
Util.try(function()
spec:normalize(Module.load(modname, modpath))
end, "Failed to load **" .. modname .. "**")
end
local path_plugins = vim.fn.stdpath("config") .. "/lua/" .. Config.spec:gsub("%.", "/")
local path_main = path_plugins .. (vim.loop.fs_stat(path_plugins .. ".lua") and ".lua" or "/init.lua")

_load(nil, path_main)
Util.lsmod(path_plugins, _load)
else
-- spec is a spec
spec:normalize(Config.spec)
end

_load(nil, Config.paths.main)
Util.lsmod(Config.paths.plugins, _load)
return spec
end

Expand Down
4 changes: 2 additions & 2 deletions lua/lazy/core/util.lua
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ function M.try(fn, msg)
end
if info.what == "Lua" and not info.source:find("lazy.nvim") then
local source = info.source:sub(2)
if source:find(Config.paths.opt, 1, true) == 1 then
source = source:sub(#Config.paths.opt + 1)
if source:find(Config.root, 1, true) == 1 then
source = source:sub(#Config.root + 1)
end
source = vim.fn.fnamemodify(source, ":p:~:.")
local line = " - " .. source .. ":" .. info.currentline
Expand Down
17 changes: 3 additions & 14 deletions lua/lazy/init.lua
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
local M = {}

---@param spec LazySpec Should be a module name to load, or a plugin spec
---@param opts? LazyConfig
function M.setup(opts)
function M.setup(spec, opts)
local module_start = vim.loop.hrtime()
require("lazy.core.module").setup()
local Util = require("lazy.core.util")
Expand All @@ -14,23 +15,11 @@ function M.setup(opts)
Util.track("setup")

Util.track("config")
Config.setup(opts)
Config.setup(spec, opts)
Util.track()

Plugin.load()

if Config.options.install_missing then
Util.track("install")
for _, plugin in pairs(Config.plugins) do
if not plugin._.installed then
vim.cmd("do User LazyInstallPre")
require("lazy.manage").install({ wait = true })
break
end
end
Util.track()
end

Util.track("loader")
Loader.setup()
Util.track()
Expand Down
13 changes: 1 addition & 12 deletions lua/lazy/view/render.lua
Original file line number Diff line number Diff line change
Expand Up @@ -193,25 +193,14 @@ function M:reason(reason, opts)
---@type string?
local source = reason.source
if source then
---@type string?
local modname = source:match("/lua/(.*)%.lua$")
if modname then
modname = modname:gsub("/", ".")
end
local name = source:match("/([^/]-)/lua")
for _, other in pairs(Config.plugins) do
if (modname and other.modname == modname) or (name and other.name == name) then
if name and other.name == name then
reason.plugin = other.name
reason.source = nil
break
end
end
if reason.source then
reason.source = modname or reason.source
if reason.source == "lua" then
reason.source = Config.options.plugins
end
end
end
local time = " " .. math.floor((reason.time or 0) / 1e6 * 100) / 100 .. "ms"
if not opts.time_right then
Expand Down

0 comments on commit af8b8e1

Please sign in to comment.