remove useless string.format(s)

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2021 chiya.dev
+Copyright (c) 2023 squibid
+Copyright (c) 2021-2023 chiya.dev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,27 +1,29 @@
 # dep
 
-[![License](https://img.shields.io/github/license/chiyadev/dep)](LICENSE)
-[![Maintainer](https://img.shields.io/badge/maintainer-luaneko-pink)][4]
-[![Issues](https://img.shields.io/github/issues/chiyadev/dep.svg)][8]
-[![Contributors](https://img.shields.io/github/contributors/chiyadev/dep.svg)][9]
-
 > This readme is a work in progress.
 
 A versatile, declarative and correct [neovim][2] package manager in [Lua][3].
-Originally written for personal use by [luaneko][4].
+Originally written for personal use by [luaneko][4]. Adapted by [squibid][5] for
+general use.
 
 What does that mean?
 
-1. `versatile` - packages can be declared in any Lua file in any order of your liking.
+1. `versatile` - packages can be declared in any Lua file in any order of your
+liking.
 2. `declarative` - packages are declared using simple Lua tables.
 3. `correct` - packages are always loaded in a correct and consistent order.
 
-See also luaneko's [neovim-configs][10] for an example of how dep can be used in practice.
+In addition to the above dep has been built to be completely in control of you,
+the user. With the help of lazy loading you can choose when your plugin loads
+down to the finest detail (examples may be found below).
+
+See also squibid's [neovim-configs][10] for an example of how dep can be used in
+practice.
 
 ## Requirements
 
-- [Neovim][2] 0.6+
+- [Neovim][2] 0.8+
-- [Git][5]
+- [Git][6] 2.13+
 
 ## Setup
 
@@ -29,11 +31,11 @@ See also luaneko's [neovim-configs][10] for an example of how dep can be used in
 
 ```lua
 -- ~/.config/nvim/lua/bootstrap.lua:
--- automatically install `chiyadev/dep` on startup
+-- automatically install `squibid/dep` on startup
 local path = vim.fn.stdpath("data") .. "/site/pack/deps/opt/dep"
 
 if vim.fn.empty(vim.fn.glob(path)) > 0 then
-  vim.fn.system({ "git", "clone", "--depth=1", "https://github.com/chiyadev/dep", path })
+  vim.fn.system({ "git", "clone", "--depth=1", "https://git.squi.bid/dep", path })
 end
 
 vim.cmd("packadd dep")
@@ -54,9 +56,7 @@ require "dep" {
   cleans removed packages and reloads packages as necessary.
 - `:DepClean` - cleans removed packages.
 - `:DepReload` - reloads all packages.
-- `:DepList` - prints the package list, performance metrics and dependency graphs.
 - `:DepLog` - opens the log file.
-- `:DepConfig` - opens the file that called dep, for convenience.
 
 ## Package specification
 
@@ -68,21 +68,25 @@ A package must be declared in the following format.
   -- This is the only required field; all other fields are optional.
   "user/package",
 
-  -- [function] Code to run after the package is loaded into neovim.
-  function()
-    require "package".setup(...)
-  end,
-
   -- [function] Code to run before the package is loaded into neovim.
   setup = function()
     vim.g.package_config = ...
   end,
 
+  -- [function] Code to run after the package is loaded into neovim.
+  load = function()
+    require "package".setup(...)
+  end,
+
   -- [function] Code to run after the package is installed or updated.
   config = function()
     os.execute(...)
   end,
 
+  -- [function] Code used to determine when the package should be loaded.
+  lazy = function(load)
+  end,
+
   -- [string] Overrides the short name of the package.
   -- Defaults to a substring of the full name after '/'.
   as = "custom_package",
@@ -91,19 +95,27 @@ A package must be declared in the following format.
   -- Defaults to "https://github.com/{full_name}.git".
   url = "https://git.chiya.dev/user/package.git",
 
+  -- [string] Overrides the source in which the package is gotten
+  -- from. This is not set by default.
+  path = "~/my-local-package/",
+
   -- [string] Overrides the name of the branch to clone.
   -- Defaults to whatever the remote configured as their HEAD, which is usually "master".
   branch = "develop",
 
+  -- [string] Overrides the commit ref to target
+  -- Defaults to the latest commit on the current branch
+  commit = "e76cb03",
+
   -- [boolean] Prevents the package from being loaded.
   disable = true,
 
   -- [boolean] Prevents the package from being updated.
   pin = true,
 
-  -- [string|array] Specifies dependencies that must be loaded before the package.
+  -- [string|array] Specifies requirements that must be loaded before the package.
   -- If given a string, it is wrapped into an array.
-  requires = {...},
+  reqs = {...},
 
   -- [string|array] Specifies dependents that must be loaded after the package.
   -- If given a string, it is wrapped into an array.
@@ -129,7 +141,7 @@ combined into one. This is useful when declaring dependencies, which is explored
 require "dep" {
   {
     "user/package",
-    requires = "user/dependency",
+    reqs = "user/dependency",
     disabled = true,
     config = function()
       print "my config hook"
@@ -150,7 +162,7 @@ require "dep" {
 require "dep" {
   {
     "user/package",
-    requires = { "user/dependency", "user/another_dependency" },
+    reqs = { "user/dependency", "user/another_dependency" },
     deps = "user/dependent",
     disabled = true,
     config = function()
@@ -171,10 +183,10 @@ they are combined into one just like normal package specifications.
 require "dep" {
   {
     "user/package",
-    requires = {
+    reqs = {
       {
         "user/dependency1",
-        requires = "user/dependency2"
+        reqs = "user/dependency2"
       }
     }
   }
@@ -197,7 +209,7 @@ require "dep" {
 require "dep" {
   {
     "user/dependency1",
-    requires = "user/dependency2",
+    reqs = "user/dependency2",
     deps = "user/package"
   }
 }
@@ -206,11 +218,11 @@ require "dep" {
 require "dep" {
   {
     "user/dependency1",
-    requires = "user/dependency2"
+    reqs = "user/dependency2"
   },
   {
     "user/package",
-    requires = "user/dependency1"
+    reqs = "user/dependency1"
   }
 }
 
@@ -237,11 +249,11 @@ instead of hanging or crashing.
 require "dep" {
   {
     "user/package1",
-    requires = "user/package2"
+    reqs = "user/package2"
   },
   {
     "user/package2",
-    requires = "user/package1"
+    reqs = "user/package1"
   }
 }
 ```
@@ -257,12 +269,12 @@ require "dep" {
   {
     "user/package1",
     disabled = true, -- implied
-    requires = "user/dependency"
+    reqs = "user/dependency"
   },
   {
     "user/package2",
     disabled = true, -- implied
-    requires = "user/dependency"
+    reqs = "user/dependency"
   }
 }
 ```
@@ -273,31 +285,85 @@ If a dependency fails to load for some reason, all of its dependents are guarant
 require "dep" {
   {
     "user/problematic",
-    function()
+    load = function()
       error("bad hook")
     end
   },
   {
     "user/dependent",
     requires = "user/problematic",
-    function()
+    load = function()
       print "unreachable"
     end
   }
 }
 ```
 
+## Lazy loading
+
+Imagine you're using [telescope.nvim][7] and you need to pull it up with a keybind,
+but you don't want to have it load before that moment. With lazy loading you may
+choose to only load it when needed using the built in lazy utils which are made
+available to you as soon as you start using the lazy option.
+
+```lua
+require "dep" {
+  { "nvim-telescope/telescope.nvim",
+    lazy = function(load)
+      load:keymap("n", "<leader>f")
+    end,
+    load = function()
+      require("telescope").setup {}
+      vim.keymap.set("n", "<leader>f", require("telescope.builtin").find_files, {})
+    end
+  }
+}
+```
+
+Say you wanted to use [gitsigns.nvim][9], but only wanted to load it when
+in a git directory OR when you call the Gitsigns command. With the power of lazy
+loading this can be accomplished by simply defining an auto command like so:
+
+```lua
+require "dep" {
+  {
+    "lewis6991/gitsigns.nvim",
+    lazy = function(load)
+      -- load gitsigns if we're in a git repository
+      load:auto({ "BufEnter", "BufNew" }, {
+        callback = function()
+          local paths = vim.fs.find({ ".git", }, { upward = true })
+          if #paths > 0 then
+            load:cleanup()
+          end
+        end
+      })
+
+      -- load gitsigns if the user trys to run the command
+      load:cmd("Gitsigns")
+    end,
+    load = function()
+      require("gitsigns").setup {}
+    end
+  }
+}
+
+```
+
+If you're in the need of a deeper understanding of how the utils work go check
+out `lua/lazy/utils.lua` for the source code.
+
 ## Separating code into modules
 
 Suppose you split your `init.lua` into two files `packages/search.lua` and
-`packages/vcs.lua`, which declare the packages [telescope.nvim][6] and [vim-fugitive][7] respectively.
+`packages/vcs.lua`, which declare the packages [telescope.nvim][7] and [vim-fugitive][8] respectively.
 
 ```lua
 -- ~/.config/nvim/lua/packages/search.lua:
 return {
   {
     "nvim-telescope/telescope.nvim",
-    requires = "nvim-lua/plenary.nvim"
+    reqs = "nvim-lua/plenary.nvim"
   }
 }
 ```
@@ -345,7 +411,7 @@ require("dep")(packages)
 require "dep" {
   {
     "nvim-telescope/telescope.nvim",
-    requires = "nvim-lua/plenary.nvim"
+    reqs = "nvim-lua/plenary.nvim"
   },
   "tpope/vim-fugitive"
 }
@@ -362,7 +428,7 @@ return {
   {
     "user/package",
     disabled = true, -- implied by module
-    requires = {
+    reqs = {
       {
         "user/dependency",
         -- disabled = true -- not implied
@@ -411,9 +477,9 @@ dep is licensed under the [MIT License](LICENSE).
 [2]: https://neovim.io/
 [3]: https://www.lua.org/
 [4]: https://github.com/luaneko
-[5]: https://git-scm.com/
+[5]: https://squi.bid
-[6]: https://github.com/nvim-telescope/telescope.nvim
+[6]: https://git-scm.com/
-[7]: https://github.com/tpope/vim-fugitive
+[7]: https://github.com/nvim-telescope/telescope.nvim
-[8]: https://GitHub.com/chiyadev/dep/issues
+[8]: https://github.com/tpope/vim-fugitive
-[9]: https://github.com/chiyadev/dep/graphs/contributors
+[9]: https://github.com/lewis6991/gitsigns.nvim
-[10]: https://github.com/luaneko/neovim-config
+[10]: https://git.squi.bid/nvim

lua/dep/fs.lua

@@ -0,0 +1,22 @@
+local h = require('dep.helpers')
+local logger = require('dep.log')
+
+local fs = {}
+
+function fs:sync(package, cb)
+  if not package.exists then
+    fs:link(package, cb)
+  end
+end
+
+function fs:link(package, cb)
+  h.uv.fs_symlink(package.path, package.dir, nil, function(err, _)
+    if err then
+      logger:log("error", "failed to symlink %s; reason: %s", package.id, err)
+    else
+      cb(err)
+    end
+  end)
+end
+
+return fs

lua/dep/git.lua

@@ -0,0 +1,166 @@
+-- TODO: clean this up, it's a mess
+-- the nesting of all the proc calls is really annoying, and I need to find a
+-- cleaner way to do it
+
+local logger = require('dep.log')
+local proc = require('dep.proc')
+
+local git = {}
+
+--- install or update a given package
+---@param package package package to update/install
+---@param cb function callback
+function git.sync(package, cb)
+  local function sync()
+    -- update or install
+    if package.exists then
+      git.update(package, cb)
+    else
+      git.install(package, cb)
+    end
+  end
+
+  -- handle arbitrary branches here
+  if package.branch then
+    proc.git_resolve_branch(package.url, package.branch, function(err, message)
+      if not err then
+        package.branch = message
+        sync()
+      end
+    end)
+  else
+    sync()
+  end
+end
+
+--- configure a package
+---@param package table package spec
+local function configurepkg(package)
+  package:runhooks("on_config")
+
+  logger:log("config", "package: %s configured", package.id)
+  package.configured = true
+end
+
+--- install a given package
+---@param package package package to install
+---@param cb function callback
+function git.install(package, cb)
+
+  if not package.enabled then
+    cb()
+    return
+  end
+
+  proc.git_clone(package.dir, package.url, package.branch, function(err, message)
+    if err then
+      logger:log("error", "failed to install %s; reason: %s",
+        package.id, message)
+    else
+      if package.commit then
+        proc.git_checkout(package.dir, package.branch, package.commit, function(err, message)
+          if err then
+            logger:log("error", "failed to checkout %s; reason: %s", package.id, message)
+          else
+            package.exists = true
+            package:unconfiguretree()
+            logger:log("install", "installed %s", package.id)
+            configurepkg(package)
+          end
+        end)
+      else
+        package.exists = true
+        package:unconfiguretree()
+        logger:log("install", "installed %s", package.id)
+        configurepkg(package)
+      end
+    end
+
+    cb(err)
+  end)
+
+end
+
+--- update a package
+---@param package package package to update
+---@param cb function callback
+function git.update(package, cb)
+  if not package.enabled then
+    cb()
+    return
+  end
+
+  local function log_err(err)
+    logger:log("error", "failed to update %s; reason: %s", package.id, err)
+  end
+
+  if package.pin then
+    cb()
+    return
+  end
+
+  local function logerr(err)
+    logger:log("error", "failed to update %s; reason: %s", package.id, err)
+  end
+
+  proc.git_rev_parse(package.dir, "HEAD", function(err, before)
+    if err then
+      logerr(before)
+      cb(err)
+    else
+      if package.commit then
+        proc.git_checkout(package.dir, package.branch, package.commit, function(err, message)
+          if err then
+            log_err(message)
+            cb(err)
+          else
+            proc.git_rev_parse(package.dir, package.commit, function(err, after)
+              if err then
+                log_err(after)
+                cb(err)
+              elseif before == after then
+                logger:log("skip", "skipped %s", package.id)
+                cb(err)
+              else
+                package:unconfiguretree()
+                logger:log("update", "updated %s; %s -> %s", package.id, before, after)
+                configurepkg(package)
+              end
+            end)
+          end
+        end)
+      else
+        proc.git_fetch(package.dir, "origin", package.branch or "HEAD", function(err, message)
+          if err then
+            log_err(message)
+            cb(err)
+          else
+            proc.git_rev_parse(package.dir, "FETCH_HEAD^{commit}", function(err, after)
+              if err then
+                log_err(after)
+                cb(err)
+              elseif before == after then
+                logger:log("skip", "skipped %s", package.id)
+                cb(err)
+              else
+                proc.git_reset(package.dir, after, function(err, message)
+                  if err then
+                    log_err(message)
+                  else
+                    package:unconfiguretree()
+                    logger:log("update", "updated %s; %s -> %s", package.id, before, after)
+                    configurepkg(package)
+                  end
+
+                  cb(err)
+                end)
+              end
+            end)
+          end
+        end)
+      end
+    end
+  end)
+end
+
+return git

lua/dep/helpers.lua

@@ -0,0 +1,4 @@
+return {
+  -- vim.loop was depricated in nvim 0.10
+  uv = vim.uv or vim.loop
+}

lua/dep/log.lua

@@ -1,23 +1,30 @@
---
+local h = require('dep.helpers')
--- Copyright (c) 2022 chiya.dev
---
--- Use of this source code is governed by the MIT License
--- which can be found in the LICENSE file and at:
---
---   https://chiya.dev/licenses/mit.txt
---
-local vim, setmetatable, pcall, debug, string, os, assert = vim, setmetatable, pcall, debug, string, os, assert
 
+local logger = {}
+
+logger.stage_colors = {
+  skip = "Comment",
+  clean = "Boolean",
+  install = "MoreMsg",
+  update = "WarningMsg",
+  delete = "Directory",
+  error = "ErrorMsg",
+}
+
+--- create the default logging path
+---@return string path to the logfile
 local function default_log_path()
-  -- ensure cache directory exists (#5)
+  -- create cache directory and chmod it if it doesn't already exist
   local path = vim.fn.stdpath("cache")
-  if not vim.loop.fs_stat(path) then
+  if not h.uv.fs_stat(path) then
-    vim.loop.fs_mkdir(path, 0x1ff) -- 0777
+    h.uv.fs_mkdir(path, 0x1ff) -- 0777
   end
 
-  return path .. "/dep.log"
+  return vim.fs.normalize(path).."/dep.log"
 end
 
+--- attempt to format a string
+---@vararg string formating args
 local function try_format(...)
   local ok, s = pcall(string.format, ...)
   if ok then
@@ -25,85 +32,69 @@ local function try_format(...)
   end
 end
 
---- Writes logs to a file and prints pretty status messages.
+--- setup all logging stuff
-local Logger = setmetatable({
+---@param path string|nil optional alternative path for the log file
-  __metatable = "Logger",
+---@return table
-  __index = {
+function logger:setup(path)
-    --- Prints a message associated with a stage.
+  logger.path = path or default_log_path()
-    log = function(self, stage, message, ...)
+  local pipe
-      -- calling function
-      local source = debug.getinfo(2, "Sl").short_src
 
-      -- format or stringify message
+  logger.handle = assert(h.uv.fs_open(logger.path, "w", 0x1a4)) -- 0644
+  pipe = h.uv.new_pipe()
+  pipe:open(logger.handle)
+
+  return pipe
+end
+
+--- log a message
+---@param level string error level
+---@param message any string message to send
+---@vararg any options to go into the message
+function logger:log(level, message, ...)
+  -- make sure the message string is actually a string, and formatted
+  -- appropriately
   if type(message) == "string" then
     message = try_format(message, ...) or message
   else
     message = vim.inspect(message)
   end
 
-      -- print and write must be done on the main event loop
+  -- get debug info about the current function
+  local source = debug.getinfo(2, "Sl")
+
+  -- schedule a log message to be sent to vim, and the log file
   vim.schedule(function()
-        if not self.silent then
+    if not logger.silent then
-          if stage == "error" then
+      if level == "error" then
-            vim.api.nvim_err_writeln(string.format("[dep] %s", message))
+        vim.api.nvim_echo({ { string.format("[dep] %s", message) } }, true, { err = true })
-          elseif self.stage_colors[stage] then
+      elseif logger.stage_colors[level] then
         vim.api.nvim_echo({
           { "[dep]", "Identifier" },
           { " " },
-              { message, self.stage_colors[stage] },
+          { message, logger.stage_colors[level] },
         }, true, {})
       end
     end
 
-        if self.pipe then
+    -- write to the pipe if it's open
-          self.pipe:write(string.format("[%s] %s: %s\n", os.date(), source, message))
+    if logger.pipe then
+      logger.pipe:write(string.format("[%s] %s:%s: %s\n", os.date("%T"), source.short_src:gsub('.*%/', ''), source.currentline, message))
     end
   end)
-    end,
-
-    --- Closes the log file handle.
-    close = function(self)
-      if self.pipe then
-        self.pipe:close()
-        self.pipe = nil
 end
 
-      if self.handle then
+--- cleanup all logging stuff
-        vim.loop.fs_close(self.handle)
+---@param pipe table? pipe
-        self.handle = nil
+---@param handle table? handle
+function logger:cleanup(pipe, handle)
+  if pipe then
+    pipe:close()
+    pipe = nil
+  end
+  if handle then
+    h.uv.fs_close(logger.handle)
+    handle = nil
+  end
 end
-    end,
-  },
-}, {
-  --- Constructs a new `Logger`.
-  __call = function(mt, path)
-    path = path or default_log_path()
 
-    -- clear and open log file
+return logger
-    local handle = assert(vim.loop.fs_open(path, "w", 0x1a4)) -- 0644
-    local pipe = vim.loop.new_pipe()
-    pipe:open(handle)
-
-    return setmetatable({
-      path = path,
-      handle = handle,
-      pipe = pipe,
-      silent = false,
-
-      -- TODO: This looks good for me ;) but it should have proper vim color mapping for other people.
-      stage_colors = {
-        skip = "Comment",
-        clean = "Boolean",
-        install = "MoreMsg",
-        update = "WarningMsg",
-        delete = "Directory",
-        error = "ErrorMsg",
-      },
-    }, mt)
-  end,
-})
-
-return {
-  Logger = Logger,
-  global = Logger(),
-}

lua/dep/package.lua

@@ -1,216 +1,559 @@
---
+local logger = require('dep.log')
--- Copyright (c) 2022 chiya.dev
---
--- Use of this source code is governed by the MIT License
--- which can be found in the LICENSE file and at:
---
---   https://chiya.dev/licenses/mit.txt
---
-local require, type, setmetatable, error, table, assert, math, os, debug =
-  require, type, setmetatable, error, table, assert, math, os, debug
-local logger = require("dep.log").global
 
-local function parse_name_from_id(id)
+-- TODO: allow specificying a path to use instead of cloning
-  local name = id:match("^[%w-_.]+/([%w-_.]+)$")
+-- like so: @field path string? path to override other url
-  if name then
+-- I might have to deal with removing dead links and what not
-    return name
+--
+-- I think it would be best to link the desired directory to the
+-- neovim package directory, but idk if that will be easy enough
+-- we'll see
+
+---@class spec
+---@field [1] string id
+---@field setup function? code to run before the package is loaded
+---@field load function? code to run after the package is loaded
+---@field config function? code to run after the package is installed/updated
+---@field lazy function? code to run which determines when the package is loaded
+---@field as string? overrides the short name of the package which is usually set
+--- to a substring of all the chars after '/' in spec[1]
+---@field url string? the url to the git repository hosting the package
+---@field path string? path to local version of plugin, overrides the url
+---@field branch string? the branch which the version of the package resides
+---@field commit string? the commit which the version of the package resides
+---@field disable boolean? if true disables the package from being loaded
+---@field pin boolean? if true disables the package from being installed/updated
+---@field reqs spec|spec[]|string? packages that this package requires
+---@field deps spec|spec[]|string? packages that depend on this package
+
+---@class package
+---@field id string id of the package
+---@field enabled boolean whether it's going to be used
+---@field exists boolean if the package exists on the filesystem
+---@field lazy boolean if the package is lazy loaded in any way
+---@field added boolean if the package has been added in vim
+---@field configured boolean if the package has been configured
+---@field lazied boolean if the packages lazy loading has been set
+---@field loaded boolean if a package has been loaded
+---@field subtree_loaded boolean is the subtree has been loaded
+---@field on_config function[] table of functions to run on config
+---@field on_setup function[] table of function to run on setup
+---@field on_load function[] table of functions to run on load
+---@field lazy_load function[] table of functions to run which will tell the package when to load
+---@field requirements package[] this package's requirements
+---@field dependents package[] packages that require this package
+---@field perf table performance metrics for the package
+---@field name string the name of the package
+---@field url string the url of the package
+---@field path string? the path of the package which overrides the url
+---@field branch string the branch of the package
+---@field dir string the directory of the package
+---@field commit string the commit of the package
+---@field pin boolean whether to pin the package or not
+local package = {}
+
+--- the base directory for the packages
+---@type string
+local base_dir
+
+--- the root package
+---@type package
+local root
+
+--- list of all package in dep
+---@type package[]
+local packages = {}
+
+--- check a spec to see if it's correct
+---@param spec spec|string the specification to check
+---@return spec|false spec if the spec is ok or false
+local function check_spec(spec)
+  -- make sure spec is a table
+  if type(spec) == "string" then
+    spec = { spec }
+  end
+
+  -- make sure all the data is correct
+  do -- spec[1]
+    if type(spec[1]) ~= "string" then
+      logger:log("spec", "spec[1] must be a string")
+      return false
+    end
+
+    local name = spec[1]:match("^[%w-_.]+/([%w-_.]+)$")
+    if not name then
+      logger:log("spec", 'invalid name "%s"; must be in the format "user/package"', spec[1])
+      return false
+    end
+  end
+
+  if spec.setup ~= nil then -- spec.setup
+    if type(spec.setup) ~= "function" then
+      logger:log("spec", "spec.setup must be a function in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.load ~= nil then -- spec.load
+    if type(spec.load) ~= "function" then
+      logger:log("spec", "spec.load must be a function in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.config ~= nil then -- spec.config
+    if type(spec.config) ~= "function" then
+      logger:log("spec", "spec.config must be a function in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.lazy ~= nil then -- spec.lazy
+    if type(spec.lazy) ~= "function" then
+      logger:log("spec", "spec.lazy must be a function in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.as ~= nil then -- spec.as
+    if type(spec.as) ~= "string" then
+      logger:log("spec", "spec.as must be a string in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.url ~= nil then -- spec.url
+    if type(spec.url) ~= "string" then
+      logger:log("spec", "spec.url must be a string in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.path ~= nil then -- spec.path
+    if type(spec.path) ~= "string" then
+      logger:log("spec", "spec.path must be a string in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.branch ~= nil then -- spec.branch
+    if type(spec.branch) ~= "string" then
+      logger:log("spec", "spec.branch must be a string in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.commit ~= nil then -- spec.commit
+    if type(spec.commit) ~= "string" then
+      logger:log("spec", "spec.commit must be a string in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.disable ~= nil then -- spec.disable
+    if type(spec.disable) ~= "boolean" then
+      logger:log("spec", "spec.disable must be a boolean in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.pin ~= nil then -- spec.pin
+    if type(spec.pin) ~= "boolean" then
+      logger:log("spec", "spec.pin must be a boolean in %s", spec[1])
+      return false
+    end
+  end
+
+  if spec.reqs ~= nil then -- spec.reqs
+    local is = type(spec.reqs)
+    if is ~= "table" and is ~= "string" then
+      logger:log("spec", "spec.reqs must be a table or a string in %s", spec[1])
+      return false
+    end
+
+    -- turn an id into a spec
+    if (is == "string") then
+      spec.reqs = { spec.reqs }
+    end
+  end
+
+  if spec.deps ~= nil then -- spec.deps
+    local is = type(spec.deps)
+    if is ~= "table" and is ~= "string" then
+      logger:log("spec", "spec.deps must be a table or a string in %s", spec[1])
+      return false
+    end
+
+    -- turn an id into a spec
+    if (is == "string") then
+      spec.deps = { spec.deps }
+    end
+  end
+
+  return spec
+end
+
+--- tell the parent it has a child and the child it has a parent
+---@param parent package? parent package if nil defaults to self
+---@param child package child package
+function package:link_dependency(parent, child)
+  parent = parent or self
+
+  if not parent.dependents[child.id] then
+    parent.dependents[child.id] = child
+    table.insert(parent.dependents, child)
+  end
+
+  if not child.requirements[parent.id] then
+    child.requirements[parent.id] = parent
+    table.insert(child.requirements, parent)
+  end
+end
+
+--- create a new package instance
+---@param spec spec|string a package spec to use for the new package
+---@param overrides spec? a package spec that is used to overried this package
+---@return package|false package an instance of the package or false on failure
+---@nodisacard
+function package:new(spec, overrides)
+  overrides = overrides or {}
+
+  -- ensure that the spec is ok
+  local new_spec = check_spec(spec)
+  if new_spec == false then
+    logger:log("spec", vim.inspect(spec))
+    logger:log("error", "spec check failed, check DepLog")
+    return false
   else
-    error(string.format('invalid package name "%s"; must be in the format "user/package"', id))
+    spec = new_spec
+  end
+
+  -- start initializing the package
+  local id = spec[1]
+
+  local o = packages[id] or {}
+  self.__index = self
+  setmetatable(o, self)
+
+  -- if package hasn't been registered already, get the inital spec regisitered
+  if not o.id then
+    o.id = id
+    o.enabled = true
+    o.exists = false
+    o.lazy = false
+    o.added = false
+    o.lazied = false
+    o.configured = false
+    o.loaded = false
+    o.subtree_loaded = false
+    o.on_config = {}
+    o.on_setup = {}
+    o.on_load = {}
+    o.lazy_load = {}
+
+    o.requirements = {}
+    o.dependents = {}
+    o.perf = {}
+
+    packages[id] = o
+  end
+
+  o.name = spec.as or o.name or id:match("^[%w-_.]+/([%w-_.]+)$")
+  o.url = spec.url or o.url or ("https://github.com/"..id..".git")
+  o.path = spec.path and vim.fs.normalize(spec.path) or spec.path
+  o.branch = spec.branch or o.branch
+  o.dir = base_dir.."/"..o.name
+  o.commit = spec.commit
+  o.pin = overrides.pin or spec.pin or o.pin
+  o.enabled = not overrides.disable and not spec.disable and o.enabled
+  o.lazy = spec.lazy ~= nil or o.lazy
+
+  -- make sure that the package exists
+  o.exists = vim.fn.isdirectory(o.dir) ~= 0
+  o.configured = o.exists
+
+  -- register all the callback functions
+  if spec.config ~= nil then
+    table.insert(o.on_config, spec.config)
+  end
+  if spec.setup ~= nil then
+    table.insert(o.on_setup, spec.setup)
+  end
+  if spec.load ~= nil then
+    table.insert(o.on_load, spec.load)
+  end
+  if spec.lazy ~= nil then
+    table.insert(o.lazy_load, spec.lazy)
+  end
+
+  -- if the current package isn't the root package then it depends on the root
+  -- package
+  if root and o ~= root then
+    o:link_dependency(root, o)
+  elseif not root then
+    root = o
+  end
+
+  -- link the dependencies
+  if spec.reqs then
+    ---it is the correct type as asserted in check_spec()
+    ---@diagnostic disable-next-line: param-type-mismatch
+    for _, req in pairs(spec.reqs) do
+      local pkg = package:new(req)
+      if type(pkg) == "table" then
+        o:link_dependency(pkg, o)
+      end
     end
   end
 
-local function is_nonempty_str(s)
+  -- and link the dependents
-  return type(s) == "string" and #s ~= 0
+  if spec.deps then
+    ---it is the correct type as asserted in check_spec()
+    ---@diagnostic disable-next-line: param-type-mismatch
+    for _, dep in pairs(spec.deps) do
+      local pkg = package:new(dep)
+      if not pkg then
+        return false
+      end
+      o:link_dependency(o, pkg)
+
+      -- if the child package is lazy loaded make sure the child package
+      -- is only loaded when the parent package has finished loading
+      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
+        pkg.lazy = true
+        table.insert(pkg.lazy_load, function(_) end)
+      end
+    end
   end
 
---- Package information.
+  return o
-local Package = setmetatable({
+end
-  __metatable = "Package",
+
-  __index = {
+--- set the base directory for packages
-    --- Runs all registered hooks of the given type.
+---@param _base_dir string base directory
-    run_hooks = function(self, hook)
+function package.set_base_dir(_base_dir)
-      local hooks = self["on_" .. hook]
+  base_dir = vim.fs.normalize(_base_dir)
-      if not hooks or #hooks == 0 then
+end
+
+--- get the base directory for packages
+---@return string base_dir
+---@nodiscard
+function package.get_base_dir()
+  return base_dir
+end
+
+--- get the root directory
+---@return package root
+---@nodiscard
+function package.get_root()
+  return root
+end
+
+--- get the packages in dep
+---@return package root
+---@nodiscard
+function package.get_packages()
+  return packages
+end
+
+--- run specified hooks on the current package
+---@param type "on_load"|"on_config"|"on_setup" which hook to run
+---@return boolean, string|nil
+function package:runhooks(type)
+  local hooks = self[type]
+  if #hooks == 0 then
     return true
   end
 
   local start = os.clock()
+
+  -- chdir into the package directory to make running external commands
+  -- from hooks easier.
+  local last_cwd = vim.fn.getcwd()
+  vim.fn.chdir(self.dir)
+
   for i = 1, #hooks do
-        local ok, err = xpcall(hooks[i], debug.traceback)
+    local ok, err = pcall(hooks[i])
     if not ok then
+      vim.fn.chdir(last_cwd)
+
       return false, err
     end
   end
 
-      local elapsed = os.clock() - start
+  vim.fn.chdir(last_cwd)
-      self.perf.hooks[hook] = elapsed
+  self.perf[type] = os.clock() - start
 
-      logger:log(
+  logger:log("hook", "triggered %d %s %s for %s", #hooks, type,
-        "hook",
+    #hooks == 1 and "hook" or "hooks", self.id)
-        "triggered %d %s %s for %s in %dms",
-        #hooks,
-        hook,
-        #hooks == 1 and "hook" or "hooks",
-        self.id,
-        elapsed
-      )
 
   return true
-    end,
-  },
-}, {
-  --- Constructs a new `Package` with the given identifier.
-  __call = function(mt, id)
-    local name = parse_name_from_id(id)
-    return setmetatable({
-      id = id,
-      name = name,
-      url = "https://github.com/" .. id .. ".git",
-      enabled = true,
-      exists = false,
-      added = false,
-      configured = false,
-      loaded = false,
-      dependencies = {},
-      dependents = {},
-      subtree_configured = false,
-      subtree_loaded = false,
-      on_setup = {},
-      on_config = {},
-      on_load = {},
-      perf = { hooks = {} },
-    }, mt)
-  end,
-})
-
---- Manages a set of packages.
-local PackageStore = setmetatable({
-  __metatable = "PackageStore",
-  __index = {
-    --- Links the given packages such that the parent must load before the child.
-    link_dependency = function(self, parent, child)
-      if not parent.dependents[child.id] then
-        parent.dependents[child.id] = child
-        parent.dependents[#parent.dependents + 1] = child
 end
 
-      if not child.dependencies[parent.id] then
+--- make sure a package has been loaded
-        child.dependencies[parent.id] = parent
+---@param force boolean? force lazy packages to load
-        child.dependencies[#child.dependencies + 1] = parent
+---@return boolean|table return true or false if loaded or package spec if lazy loaded
-      end
+function package:ensureadded(force)
-    end,
+  --- load a package
-
+  ---@param pkg package
-    --- Ensures the given package spec table is valid.
+  local function loadpkg(pkg)
-    validate_spec = function(self, spec)
+    -- make sure to load the dependencies first
-      assert(spec[1] ~= nil, "package id missing from spec")
+    for _, p in pairs(pkg.requirements) do
-      assert(type(spec[1]) == "string", "package id must be a string")
+      if not p.loaded then
-      parse_name_from_id(spec[1])
+        p:ensureadded(true)
-
-      assert(spec.as == nil or is_nonempty_str(spec.as), "package name must be a string")
-      assert(spec.url == nil or type(spec.url) == "string", "package url must be a string") -- TODO: validate url or path
-      assert(spec.branch == nil or is_nonempty_str(spec.branch), "package branch must be a string")
-      assert(spec.pin == nil or type(spec.pin) == "boolean", "package pin must be a boolean")
-      assert(spec.disable == nil or type(spec.disable) == "boolean", "package disable must be a boolean")
-
-      assert(
-        spec.requires == nil or type(spec.requires) == "table" or type(spec.requires) == "string",
-        "package requires must be a string or table"
-      )
-      assert(
-        spec.deps == nil or type(spec.deps) == "table" or type(spec.deps) == "string",
-        "package deps must be a string or table"
-      )
-
-      assert(spec.setup == nil or type(spec.setup) == "function", "package setup must be a function")
-      assert(spec.config == nil or type(spec.config) == "function", "package config must be a function")
-      assert(spec[2] == nil or type(spec[2]) == "function", "package loader must be a function")
-    end,
-
-    --- Creates or updates a package from the given spec table, and returns that package.
-    add_spec = function(self, spec, scope)
-      self:validate_spec(spec)
-      scope = scope or {}
-
-      local id = spec[1]
-      local pkg = self[id]
-
-      if not pkg then
-        pkg = Package(id)
-        self[id], self[#self + 1] = pkg, pkg
-      end
-
-      -- blend package spec with existing package info
-      pkg.name = spec.as or pkg.name
-      pkg.url = spec.url or pkg.url
-      pkg.branch = spec.branch or pkg.branch
-      pkg.pin = scope.pin or spec.pin or pkg.pin
-      pkg.enabled = not scope.disable and not spec.disable and pkg.enabled
-
-      pkg.on_setup[#pkg.on_setup + 1] = spec.setup
-      pkg.on_config[#pkg.on_config + 1] = spec.config
-      pkg.on_load[#pkg.on_load + 1] = spec[2]
-
-      local requires = type(spec.requires) == "table" and spec.requires or { spec.requires }
-      local deps = type(spec.deps) == "table" and spec.deps or { spec.deps }
-
-      -- recursively add specs for dependencies and dependents
-      for i = 1, #requires do
-        self:link_dependency(self:add_spec(requires[i], scope), pkg)
-      end
-
-      for i = 1, #deps do
-        self:link_dependency(pkg, self:add_spec(deps[i], scope))
-      end
-    end,
-
-    --- Adds the given list of specs.
-    add_specs = function(self, specs, scope)
-      assert(type(specs) == "table", "package list must be a table")
-      assert(specs.pin == nil or type(specs.pin) == "boolean", "package list pin must be a boolean")
-      assert(specs.disable == nil or type(specs.disable) == "boolean", "package list disable must be a boolean")
-      assert(specs.modules == nil or type(specs.modules) == "table", "package list module list must be a table")
-
-      scope = scope or {}
-      scope = {
-        -- outer scope takes precedence over inner list's overrides
-        pin = scope.pin or specs.pin,
-        disable = scope.disable or specs.disable,
-      }
-
-      -- add specs in spec list
-      for i = 1, #specs do
-        self:add_spec(specs[i], scope)
-      end
-
-      -- recursively add referenced spec list modules
-      if specs.modules then
-        local prefix = specs.modules.prefix or ""
-        for i = 1, #specs.modules do
-          local name = specs.modules[i]
-          assert(type(name) == "string", "package list inner module name must be a string")
-          name = prefix .. name
-
-          local module = require(name)
-          assert(type(module) == "table", "package list inner module did not return a spec list table")
-          self:add_specs(module, scope)
       end
     end
-    end,
 
-    --- Ensures there are no circular dependencies in this package store.
+    -- run setup hooks
-    ensure_acyclic = function(self)
+    pkg:runhooks("on_setup")
-      -- tarjan's strongly connected components algorithm
-      local idx, indices, lowlink, stack = 0, {}, {}, {}
 
+    -- now start loading our plugin
+    local start = os.clock()
+
+    -- trigger the packadd for the plugin
+    ---@diagnostic disable-next-line: param-type-mismatch
+    local ok, err = pcall(vim.cmd, "packadd "..pkg.name)
+    if not ok then
+      return false, err
+    end
+
+    pkg.added = true
+    pkg.perf.pack = os.clock() - start
+    logger:log("vim", "packadd completed for %s", pkg.id)
+
+    -- set the package to loaded
+    pkg.loaded = true
+    logger:log("load", "loaded %s", pkg.id)
+
+    -- trigger the on_load hooks
+    ok, err = pkg:runhooks("on_load")
+    if not ok then
+      logger:log("error", "failed to load %s; reason: %s", pkg.id, err)
+      return
+    end
+  end
+
+  -- make sure the package is lazy loaded if need be
+  if not self.added and not self.loaded and not self.lazy or force then
+    loadpkg(self)
+  elseif not self.added and self.lazy then
+    logger:log("lazy", "registering %d lazy hooks for %s", #self.lazy_load,
+      self.id)
+    self.lazied = true
+    for _, load_cond in pairs(self.lazy_load) do
+      -- configure the lazy loader for the user
+      local l = require('lazy.utils'):new()
+      if l == true then
+        logger:log("lazy", "failed to get lazy utils")
+        return false
+      end
+      l:set_load(function()
+        logger:log("lazy", "triggered %d lazy hooks for %s", #self.lazy_load,
+          self.id)
+        loadpkg(self)
+      end)
+
+      -- run it
+      load_cond(l)
+    end
+    return self
+  end
+
+  return true
+end
+
+--- load all packages in package tree
+---@param force boolean? force lazy packages to load
+---@return boolean boolean if tree was successfully loaded
+---@nodiscard
+function package:loadtree(force)
+  -- if the package doesn't exist or isn't enabled then don't load it
+  if not self.exists or not self.enabled then
+    return false
+  end
+
+  -- if the subtree is loaded then it's already loaded unless it needs forcing
+  if not force and self.subtree_loaded then
+    return true
+  end
+
+  -- if the package isn't lazy check that it's requirements are loaded
+  if not self.lazy then
+    for _, requirement in pairs(self.requirements) do
+      if not requirement.loaded and not requirement.lazy then
+        return false
+      end
+    end
+  end
+
+  -- if the package isn't loaded and isn't lazy then it should probably be
+  -- loaded
+  if not self.loaded then
+    local ok, err = self:ensureadded(force)
+    if not ok then
+      logger:log("error", "failed to load %s; reason: %s", self.id, err)
+      return false
+    end
+  end
+
+  self.subtree_loaded = true
+
+  -- make sure the dependants are loaded
+  for _, dependant in pairs(self.dependents) do
+    self.subtree_loaded = dependant:loadtree(force) and self.subtree_loaded
+  end
+
+  return self.subtree_loaded
+end
+
+--- unconfigure a packages tree
+function package:unconfiguretree()
+  -- unconfigure requirements
+  for _, requirement in pairs(self.requirements) do
+    requirement.subtree_loaded = false
+  end
+
+  -- unconfigure dependents
+  for _, dependant in pairs(self.dependents) do
+    dependant.loaded = false
+    dependant.added = false
+    dependant.configured = false
+
+    dependant.subtree_loaded = false
+  end
+end
+
+--- check a list of packages for any cycles
+---@param pkgs package[] list of packages
+---@return package[]|false cycle the cycle that was found or false if not found
+---@nodisacard
+function package.findcycle(pkgs)
+  local index = 0
+  local indexes = {}
+  local lowlink = {}
+  local stack = {}
+
+  --- use tarjan algorithm to find circular dependencies (strongly connected
+  --- components)
+  ---@param pkg package
   local function connect(pkg)
-        indices[pkg.id], lowlink[pkg.id] = idx, idx
+    indexes[pkg.id], lowlink[pkg.id] = index, index
     stack[#stack + 1], stack[pkg.id] = pkg, true
-        idx = idx + 1
+    index = index + 1
 
     for i = 1, #pkg.dependents do
       local dependent = pkg.dependents[i]
 
-          if not indices[dependent.id] then
+      if not indexes[dependent.id] then
         local cycle = connect(dependent)
         if cycle then
           return cycle
@@ -218,11 +561,11 @@ local PackageStore = setmetatable({
           lowlink[pkg.id] = math.min(lowlink[pkg.id], lowlink[dependent.id])
         end
       elseif stack[dependent.id] then
-            lowlink[pkg.id] = math.min(lowlink[pkg.id], indices[dependent.id])
+        lowlink[pkg.id] = math.min(lowlink[pkg.id], indexes[dependent.id])
       end
     end
 
-        if lowlink[pkg.id] == indices[pkg.id] then
+    if lowlink[pkg.id] == indexes[pkg.id] then
       local cycle = { pkg }
       local node
 
@@ -232,42 +575,25 @@ local PackageStore = setmetatable({
         cycle[#cycle + 1] = node
       until node == pkg
 
-          -- a node is by definition strongly connected to itself
+      -- a node is by definition strongly connected to itself ignore single-node
-          -- ignore single-node components unless the package explicitly specified itself as a dependency (i.e. the user is being weird)
+      -- components unless it explicitly specified itself as a dependency
       if #cycle > 2 or pkg.dependents[pkg.id] then
         return cycle
       end
     end
   end
 
-      for i = 1, #self do
+  -- actually check the cycle
-        local pkg = self[i]
+  for _, pkg in pairs(pkgs) do
-
+    if not indexes[package.id] then
-        if not indices[pkg.id] then
       local cycle = connect(pkg)
       if cycle then
-            -- found dependency cycle
+        return cycle
-            local names = {}
-            for j = 1, #cycle do
-              names[j] = cycle[j].id
-            end
-            error("circular dependency detected in package dependency graph: " .. table.concat(names, " -> "))
       end
     end
   end
-    end,
-  },
-}, {
-  --- Constructs a new `PackageStore`.
-  __call = function(mt)
-    -- hash part of store maps package ids to packages
-    -- array part of store is a list of packages
-    -- all packages in a store are unique based on their id
-    return setmetatable({}, mt)
-  end,
-})
 
-return {
+  return false
-  Package = Package,
+end
-  PackageStore = PackageStore,
+
-}
+return package

lua/dep/proc.lua

@@ -1,23 +1,19 @@
-local logger = require("dep.log").global
 local proc = {}
 
+--- execute a process
+---@param process string the program
+---@param args string[] the args
+---@param cwd string? the pwd
+---@param env table env
+---@param cb function callback
 function proc.exec(process, args, cwd, env, cb)
   local buffer = {}
 
   local function cb_output(_, data, _)
     table.insert(buffer, table.concat(data))
   end
-  local function cb_exit(job_id, exit_code, _)
+  local function cb_exit(_, exit_code, _)
     local output = table.concat(buffer)
-    logger:log(
-      process,
-      string.format(
-      'Job %s ["%s"] finished with exitcode %s\n%s',
-      job_id,
-      table.concat(args, '", "'),
-      exit_code,
-      output)
-    )
     cb(exit_code ~= 0, output)
   end
   table.insert(args, 1, process)
@@ -61,4 +57,72 @@ function proc.git_reset(dir, treeish, cb)
   proc.exec("git", args, dir, git_env, cb)
 end
 
+function proc.git_checkout(dir, branch, commit, cb)
+  local args = { "fetch", "--depth=2147483647", "origin", branch }
+  proc.exec("git", args, dir, git_env, function(err, message)
+    cb(err, message)
+
+    args = { "checkout", commit }
+    proc.exec("git", args, dir, git_env, cb)
+  end)
+end
+
+function proc.git_resolve_branch(url, branch, cb)
+  -- if the branch doesn't contain a * then return the branch
+  if not string.match(branch, "*") then
+    cb(false, branch)
+    return
+  end
+
+  local buffer = {}
+  local function cb_output(_, data, _)
+    if data[1] ~= "" then
+      buffer = data
+    end
+  end
+
+  vim.fn.jobstart({ "git", "ls-remote", "--tags", "--sort", "v:refname", url },
+    {
+      cwd = nil,
+      env = git_env,
+      stdin = nil,
+      on_stdout = cb_output,
+      on_stderr = cb_output,
+      on_exit = function(_, exit_code, _)
+        if exit_code ~= 0 then
+          return
+        end
+
+        -- get a list of all versions
+        local versions = {}
+        for _, v in pairs(buffer) do
+          local s, e = string.find(v, "refs/tags/.+")
+          if not s or not e then
+            goto continue
+          end
+
+          local tag = string.sub(v, s, e)
+          tag = tag:gsub("refs/tags/", ""):gsub("%^{}", "")
+
+          table.insert(versions, tag)
+          ::continue::
+        end
+
+        -- match the chosen version against all versions
+        for i = #versions, 1, -1 do
+          if branch == "*" then
+            cb(false, versions[i])
+            return
+          else
+            local r = string.match(versions[i], branch)
+            if r then
+              cb(false, r)
+              return
+            end
+          end
+        end
+      end
+    })
+end
+
 return proc

lua/dep2.lua

@@ -1,12 +0,0 @@
---
--- Copyright (c) 2022 chiya.dev
---
--- Use of this source code is governed by the MIT License
--- which can be found in the LICENSE file and at:
---
---   https://chiya.dev/licenses/mit.txt
---
-local logger = require("dep.log").global
-local store = require("dep.package").PackageStore()
-
--- placeholder for refactoring

lua/lazy/utils.lua

@@ -0,0 +1,116 @@
+local logger = require('dep.log')
+
+---@class lazy
+---@field load function the function to load the plugin
+---@field command_ids table the commands that have been registered
+---@field auto_ids table the auto commands that have been registered
+---@field keybind_ids table the keybinds that have been registered
+local lazy = {}
+
+--- create a new instance of lazy
+---@return lazy
+function lazy:new()
+  local o = {}
+
+  setmetatable(o, self)
+  o.command_ids = {}
+  o.auto_ids = {}
+  o.keybind_ids = {}
+
+  self.__index = self
+
+  return o
+end
+
+--- set the loading function
+---@param load function the loading function
+function lazy:set_load(load)
+  self.load = load
+end
+
+--- get the configured load function
+---@return function load function
+function lazy:get_load()
+  return self.load
+end
+
+--- create a usercommand which will trigger the plugin to load
+---@param name string the name of the command
+---@param opts vim.api.keyset.user_command? options
+function lazy:cmd(name, opts)
+  opts = opts or {}
+  vim.api.nvim_create_user_command(name, opts['callback'] or function()
+    self:cleanup()
+  end, opts)
+
+  table.insert(self.command_ids, name)
+end
+
+--- user an auto command which will trigger the plugin to load
+---@param event string the event to trigger on
+---@param opts vim.api.keyset.create_autocmd? options
+function lazy:auto(event, opts)
+  opts = opts or {}
+
+  opts['callback'] = opts['callback'] or function()
+    self:cleanup()
+  end
+
+  -- create the auto command and save it
+  table.insert(self.auto_ids, vim.api.nvim_create_autocmd(event, opts))
+end
+
+--- create a keybind which will trigger the plugin to load
+---@param mode string the mode to trigger in
+---@param bind string the binding to use
+---@param opts vim.keymap.set.Opts? options
+function lazy:keymap(mode, bind, opts)
+  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
+
+  vim.keymap.set(mode, bind, opts['callback'] or function()
+    -- register keymap unload
+    self:cleanup()
+
+    -- call the keymap after the user has mapped it
+    if rerun then
+      local keys = vim.api.nvim_replace_termcodes(bind, true, false, true)
+      vim.api.nvim_input(keys)
+    end
+  end, opts)
+
+  table.insert(self.keybind_ids, { ['mode'] = mode, ['bind'] = bind })
+end
+
+--- cleanup all the callbacks, and load the plugin
+function lazy:cleanup()
+    -- cleanup user commands
+  for _, command_id in pairs(self.command_ids) do
+    local ok, err = pcall(vim.api.nvim_del_user_command, command_id)
+    if not ok then
+      logger:log("lazy", err or "failed to delete user command")
+    end
+  end
+  -- cleanup auto commands
+  for _, auto_id in pairs(self.auto_ids) do
+    local ok, err = pcall(vim.api.nvim_del_autocmd, auto_id)
+    if not ok then
+      logger:log("lazy", err or "failed to delete auto command")
+    end
+  end
+  -- cleanup keymaps
+  for _, keybind_id in pairs(self.keybind_ids) do
+    local ok, err = pcall(vim.keymap.del, keybind_id.mode, keybind_id.bind, {})
+    if not ok then
+      logger:log("lazy", err or "failed to delete keymap")
+    end
+  end
+  -- load the plugin
+  self:load()
+end
+
+return lazy

stylua.toml

@@ -1,2 +0,0 @@
-indent_type = "Spaces"
-indent_width = 2