Compare commits
9 Commits
cfc3f08d53
...
lazy
Author | SHA1 | Date | |
---|---|---|---|
70853bd01e
|
|||
9d4322572c
|
|||
3b33a604d8
|
|||
5aff147731
|
|||
edf32fbf06
|
|||
adec93b7f4
|
|||
1cd5f63f8e
|
|||
8e46eddecd
|
|||
542298c1fe
|
75
doc/dep.txt
75
doc/dep.txt
@ -15,6 +15,7 @@ Table of Contents *dep-table-of-contents*
|
|||||||
6. Examples |dep-examples|
|
6. Examples |dep-examples|
|
||||||
- Declaring Dependencies |dep-examples-declaring-dependencies|
|
- Declaring Dependencies |dep-examples-declaring-dependencies|
|
||||||
- Modules |dep-examples-modules|
|
- Modules |dep-examples-modules|
|
||||||
|
- Lazy Loading |dep-examples-lazy-loading|
|
||||||
7. Credits & License |dep-credits|
|
7. Credits & License |dep-credits|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
@ -216,10 +217,17 @@ is equivalent to the following:
|
|||||||
load:cmd("Command", {
|
load:cmd("Command", {
|
||||||
callback = function()
|
callback = function()
|
||||||
load:cleanup()
|
load:cleanup()
|
||||||
|
|
||||||
|
if (rerun) then
|
||||||
|
vim.cmd("Command")
|
||||||
|
end
|
||||||
end
|
end
|
||||||
})
|
})
|
||||||
<
|
<
|
||||||
If you wish the second argument may be completely ommitted.
|
If you wish the second argument may be completely ommitted. Note the inclusion
|
||||||
|
of a `rerun` field, this is a parameter which may be passed into the options table
|
||||||
|
to re-run the binding after loading the package. You may choose to disable the
|
||||||
|
built-in logic by passing false.
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
LOAD:AUTO *dep-lazy-loading-api-auto*
|
LOAD:AUTO *dep-lazy-loading-api-auto*
|
||||||
@ -293,6 +301,27 @@ into the options table to re-run the binding after loading the package. You
|
|||||||
may choose to include your own logic by passing a function to the `rerun`
|
may choose to include your own logic by passing a function to the `rerun`
|
||||||
field or disable the built-in logic by passing false.
|
field or disable the built-in logic by passing false.
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
LOAD:PLUGIN *dep-lazy-loading-api-plugin*
|
||||||
|
|
||||||
|
`load:plugin` is a function which allows you to specify another plugin for the
|
||||||
|
package to load after. It takes two arguments: `plugin` which is the name of
|
||||||
|
the plugin you want to follow like: 'user/package'. The second argument is
|
||||||
|
`opts` which is a table with one option: `callback` which is a function. The
|
||||||
|
following is an example:
|
||||||
|
>lua
|
||||||
|
load:plugin("user/package", {})
|
||||||
|
<
|
||||||
|
Which is the same as:
|
||||||
|
>lua
|
||||||
|
load:plugin("user/package", {
|
||||||
|
callback = function()
|
||||||
|
self:cleanup()
|
||||||
|
end
|
||||||
|
})
|
||||||
|
<
|
||||||
|
When 'user/package' is already loaded the `callback` is called immediately.
|
||||||
|
|
||||||
LAZY LOADING API SHORTHANDS *dep-lazy-loading-api-shorthands*
|
LAZY LOADING API SHORTHANDS *dep-lazy-loading-api-shorthands*
|
||||||
|
|
||||||
On occasion you may wish to only define one condition for the package to load.
|
On occasion you may wish to only define one condition for the package to load.
|
||||||
@ -589,6 +618,50 @@ declared in that module.
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
<
|
<
|
||||||
|
LAZY LOADING *dep-examples-lazy-loading*
|
||||||
|
|
||||||
|
Lazy loading is a very complicated topic, and therefore this part of the
|
||||||
|
documentation assumes you have experience with regular package managment.
|
||||||
|
Let's go over loading order, and how the lazy loader determines what needs to
|
||||||
|
be loaded.
|
||||||
|
|
||||||
|
Let's say we have the following spec:
|
||||||
|
>lua
|
||||||
|
{ "user/package",
|
||||||
|
lazy = true,
|
||||||
|
deps = "user/dependent"
|
||||||
|
}
|
||||||
|
<
|
||||||
|
This is the same as the following:
|
||||||
|
>lua
|
||||||
|
{ "user/package",
|
||||||
|
lazy = true
|
||||||
|
},
|
||||||
|
|
||||||
|
{ "user/dependent",
|
||||||
|
reqs = "user/package",
|
||||||
|
lazy = require("dep.lazy.loader.short").plugin("user/package")
|
||||||
|
}
|
||||||
|
<
|
||||||
|
What you're seeing is implicit lazy loading. By default dep will lazy load
|
||||||
|
dependents who are explicitly defined in the spec. Now if we we're to modify
|
||||||
|
'user/dependent' like so:
|
||||||
|
>lua
|
||||||
|
{ "user/package",
|
||||||
|
lazy = true
|
||||||
|
},
|
||||||
|
|
||||||
|
{ "user/dependent",
|
||||||
|
reqs = "user/package",
|
||||||
|
lazy = function(load)
|
||||||
|
load:plugin("user/package")
|
||||||
|
load:cmd("LoadDependent")
|
||||||
|
end
|
||||||
|
}
|
||||||
|
<
|
||||||
|
If we were to call the command `:LoadDependent` it would first load
|
||||||
|
'user/package', and then load 'user/dependent'.
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
7. Credits & License *dep-credits*
|
7. Credits & License *dep-credits*
|
||||||
|
|
||||||
|
@ -1,10 +1,12 @@
|
|||||||
local logger = require('dep.log')
|
local logger = require('dep.log')
|
||||||
|
local packager = require('dep.package')
|
||||||
|
|
||||||
---@class lazy_loader
|
---@class lazy_loader
|
||||||
---@field load function the function to load the plugin
|
---@field load function the function to load the plugin
|
||||||
---@field command_ids table the commands that have been registered
|
---@field command_ids string[] the commands that have been registered
|
||||||
---@field auto_ids table the auto commands that have been registered
|
---@field auto_ids number[] the auto commands that have been registered
|
||||||
---@field keybind_ids table the keybinds that have been registered
|
---@field keybind_ids table[] the keybinds that have been registered
|
||||||
|
---@field plugin_ids table[] the plugins that have been registered
|
||||||
local lazy_loader = {}
|
local lazy_loader = {}
|
||||||
|
|
||||||
--- create a new instance of lazy
|
--- create a new instance of lazy
|
||||||
@ -16,6 +18,7 @@ function lazy_loader:new()
|
|||||||
o.command_ids = {}
|
o.command_ids = {}
|
||||||
o.auto_ids = {}
|
o.auto_ids = {}
|
||||||
o.keybind_ids = {}
|
o.keybind_ids = {}
|
||||||
|
o.plugin_ids = {}
|
||||||
|
|
||||||
self.__index = self
|
self.__index = self
|
||||||
|
|
||||||
@ -34,6 +37,11 @@ end
|
|||||||
function lazy_loader:cmd(name, opts)
|
function lazy_loader:cmd(name, opts)
|
||||||
opts = opts or {}
|
opts = opts or {}
|
||||||
|
|
||||||
|
-- move the rerun arg to a seperate variable because keymap.set doesn't like
|
||||||
|
-- options it doesn't know of
|
||||||
|
local rerun = opts["rerun"] or true
|
||||||
|
opts['rerun'] = nil
|
||||||
|
|
||||||
-- load the plugin on completion
|
-- load the plugin on completion
|
||||||
if not opts["complete"] then
|
if not opts["complete"] then
|
||||||
opts["complete"] = function(_, line, _)
|
opts["complete"] = function(_, line, _)
|
||||||
@ -49,6 +57,11 @@ function lazy_loader:cmd(name, opts)
|
|||||||
|
|
||||||
vim.api.nvim_create_user_command(name, opts['callback'] or function(_)
|
vim.api.nvim_create_user_command(name, opts['callback'] or function(_)
|
||||||
self:cleanup()
|
self:cleanup()
|
||||||
|
|
||||||
|
-- attempt to rerun the command
|
||||||
|
if not rerun then
|
||||||
|
pcall(vim.cmd, name)
|
||||||
|
end
|
||||||
end, opts)
|
end, opts)
|
||||||
|
|
||||||
table.insert(self.command_ids, name)
|
table.insert(self.command_ids, name)
|
||||||
@ -71,7 +84,7 @@ end
|
|||||||
--- create an auto command which will trigger on filetype
|
--- create an auto command which will trigger on filetype
|
||||||
---@param filetype string filetype to register the auto on
|
---@param filetype string filetype to register the auto on
|
||||||
function lazy_loader:ft(filetype)
|
function lazy_loader:ft(filetype)
|
||||||
lazy_loader:auto("FileType", {
|
self:auto("FileType", {
|
||||||
pattern = filetype
|
pattern = filetype
|
||||||
})
|
})
|
||||||
end
|
end
|
||||||
@ -107,29 +120,53 @@ function lazy_loader:keymap(mode, bind, opts)
|
|||||||
table.insert(self.keybind_ids, { ['mode'] = mode, ['bind'] = bind })
|
table.insert(self.keybind_ids, { ['mode'] = mode, ['bind'] = bind })
|
||||||
end
|
end
|
||||||
|
|
||||||
|
--- load a plugin when another plugin loads
|
||||||
|
---@param plugin string plugin name
|
||||||
|
---@param opts table? options
|
||||||
|
function lazy_loader:plugin(plugin, opts)
|
||||||
|
opts = opts or {}
|
||||||
|
opts["callback"] = opts["callback"] or function()
|
||||||
|
self:cleanup()
|
||||||
|
end
|
||||||
|
|
||||||
|
if packager.get_packages()[plugin].loaded then
|
||||||
|
opts["callback"]()
|
||||||
|
else
|
||||||
|
local on_load = packager.get_packages()[plugin].on_load
|
||||||
|
local on_load_idx = #on_load + 1
|
||||||
|
on_load[on_load_idx] = opts["callback"]
|
||||||
|
|
||||||
|
table.insert(self.plugin_ids, { plugin, on_load_idx })
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
--- cleanup all the callbacks, and load the plugin
|
--- cleanup all the callbacks, and load the plugin
|
||||||
function lazy_loader:cleanup()
|
function lazy_loader:cleanup()
|
||||||
-- cleanup user commands
|
-- cleanup user commands
|
||||||
for _, command_id in pairs(self.command_ids) do
|
for _, command_id in ipairs(self.command_ids) do
|
||||||
local ok, err = pcall(vim.api.nvim_del_user_command, command_id)
|
local ok, err = pcall(vim.api.nvim_del_user_command, command_id)
|
||||||
if not ok then
|
if not ok then
|
||||||
logger:log("lazy", err or "failed to delete user command")
|
logger:log("lazy", err or "failed to delete user command")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
-- cleanup auto commands
|
-- cleanup auto commands
|
||||||
for _, auto_id in pairs(self.auto_ids) do
|
for _, auto_id in ipairs(self.auto_ids) do
|
||||||
local ok, err = pcall(vim.api.nvim_del_autocmd, auto_id)
|
local ok, err = pcall(vim.api.nvim_del_autocmd, auto_id)
|
||||||
if not ok then
|
if not ok then
|
||||||
logger:log("lazy", err or "failed to delete auto command")
|
logger:log("lazy", err or "failed to delete auto command")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
-- cleanup keymaps
|
-- cleanup keymaps
|
||||||
for _, keybind_id in pairs(self.keybind_ids) do
|
for _, keybind_id in ipairs(self.keybind_ids) do
|
||||||
local ok, err = pcall(vim.keymap.del, keybind_id.mode, keybind_id.bind, {})
|
local ok, err = pcall(vim.keymap.del, keybind_id.mode, keybind_id.bind, {})
|
||||||
if not ok then
|
if not ok then
|
||||||
logger:log("lazy", err or "failed to delete keymap")
|
logger:log("lazy", err or "failed to delete keymap")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
-- cleanup plugins
|
||||||
|
for _, plugin_id in ipairs(self.plugin_ids) do
|
||||||
|
table.remove(packager.get_packages()[plugin_id[1]].on_load, plugin_id[2])
|
||||||
|
end
|
||||||
-- load the plugin
|
-- load the plugin
|
||||||
self:load()
|
self:load()
|
||||||
end
|
end
|
||||||
|
@ -59,4 +59,14 @@ function short.keymap(mode, bind, opts)
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
--- create a single plugin load event for when another plugin loads
|
||||||
|
---@param plugin string plugin name
|
||||||
|
---@param opts table? options
|
||||||
|
---@return function callback
|
||||||
|
function short.plugin(plugin, opts)
|
||||||
|
return function(load)
|
||||||
|
load:plugin(plugin, opts)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
return short
|
return short
|
||||||
|
@ -165,18 +165,10 @@ function package:new(spec, overrides)
|
|||||||
-- if the child package is lazy loaded make sure the child package
|
-- if the child package is lazy loaded make sure the child package
|
||||||
-- is only loaded when the parent package has finished loading
|
-- is only loaded when the parent package has finished loading
|
||||||
if o.lazy then
|
if o.lazy then
|
||||||
table.insert(o.on_load, function()
|
|
||||||
local ok = o:loadtree(true)
|
|
||||||
if not ok then
|
|
||||||
logger:log("lazy",
|
|
||||||
"failed to run loadtree for %s, some packages may not be loaded",
|
|
||||||
o.id)
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
|
|
||||||
-- tell the dep that it's gonna be lazy
|
-- tell the dep that it's gonna be lazy
|
||||||
pkg.lazy = true
|
pkg.lazy = true
|
||||||
table.insert(pkg.lazy_load, function(_) end)
|
table.insert(pkg.lazy_load,
|
||||||
|
require("dep.lazy.loader.short").plugin(id))
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@ -252,6 +244,10 @@ function package:ensureadded(force)
|
|||||||
--- load a package
|
--- load a package
|
||||||
---@param pkg package
|
---@param pkg package
|
||||||
local function loadpkg(pkg)
|
local function loadpkg(pkg)
|
||||||
|
if not self.enabled then
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
-- make sure to load the dependencies first
|
-- make sure to load the dependencies first
|
||||||
for _, p in pairs(pkg.requirements) do
|
for _, p in pairs(pkg.requirements) do
|
||||||
if not p.loaded then
|
if not p.loaded then
|
||||||
@ -316,7 +312,7 @@ function package:ensureadded(force)
|
|||||||
if load_cond ~= true then
|
if load_cond ~= true then
|
||||||
local ok, err = pcall(load_cond, l)
|
local ok, err = pcall(load_cond, l)
|
||||||
if not ok then
|
if not ok then
|
||||||
logger:log("lazy", "failed to register load conditions for '%s': %s",
|
logger:log("error", "failed to register lazy load conditions for '%s': %s",
|
||||||
self.name, err)
|
self.name, err)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
@ -20,16 +20,29 @@ end
|
|||||||
---@param log_line string log line
|
---@param log_line string log line
|
||||||
---@return chunk[] chunks
|
---@return chunk[] chunks
|
||||||
function format.log_line(log_line)
|
function format.log_line(log_line)
|
||||||
local log_time = string.sub( log_line, string.find(log_line, "%[") + 1,
|
-- make sure we don't do operations on nil values
|
||||||
string.find(log_line, "%]") - 1)
|
if not log_line or log_line == "" then
|
||||||
local colon = string.find(log_line, ":", 11)
|
return {}
|
||||||
local log_path = string.sub(log_line, string.find(log_line, "%]") + 2,
|
end
|
||||||
colon - 1)
|
|
||||||
local log_path_ln = string.sub(log_line, colon + 1,
|
-- error on any nil values, this should prevent us from parsing an incorrectly
|
||||||
string.find(log_line, ":", colon + 1) - 1)
|
-- formatted log line
|
||||||
local level = string.sub(log_line, string.find(log_line, "%(") + 1,
|
local log_time, colon, log_path, log_path_ln, level, rest
|
||||||
string.find(log_line, "%)") - 1)
|
local ok = pcall(function()
|
||||||
local rest = string.sub(log_line, string.find(log_line, "%)") + 2)
|
log_time = string.sub(log_line, string.find(log_line, "%[") + 1,
|
||||||
|
string.find(log_line, "%]") - 1)
|
||||||
|
colon = string.find(log_line, ":", 11)
|
||||||
|
log_path = string.sub(log_line, string.find(log_line, "%]") + 2,
|
||||||
|
colon - 1)
|
||||||
|
log_path_ln = string.sub(log_line, colon + 1,
|
||||||
|
string.find(log_line, ":", colon + 1) - 1)
|
||||||
|
level = string.sub(log_line, string.find(log_line, "%(") + 1,
|
||||||
|
string.find(log_line, "%)") - 1)
|
||||||
|
rest = string.sub(log_line, string.find(log_line, "%)") + 2)
|
||||||
|
end)
|
||||||
|
if not ok then
|
||||||
|
return {}
|
||||||
|
end
|
||||||
|
|
||||||
return {
|
return {
|
||||||
{ "[", "" },
|
{ "[", "" },
|
||||||
|
@ -17,6 +17,14 @@ describe("ui log formatting", function()
|
|||||||
},
|
},
|
||||||
dep_ui_format.log_line("[11:22:33] file.lua:1:(vim) some fancy message")
|
dep_ui_format.log_line("[11:22:33] file.lua:1:(vim) some fancy message")
|
||||||
)
|
)
|
||||||
|
|
||||||
|
-- malformed log line
|
||||||
|
assert.same({},
|
||||||
|
dep_ui_format.log_line("11:22:33] file.lua:1:(vim) some fancy message"))
|
||||||
|
|
||||||
|
-- test nil values
|
||||||
|
assert.same({}, dep_ui_format.log_line(""))
|
||||||
|
assert.same({}, dep_ui_format.log_line(nil))
|
||||||
end)
|
end)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user