types dir -> types file, log module out of util

Author: clpi

README.md

@@ -52,22 +52,27 @@ the _familiar_, organized future for neovim and beyond!
 -- Place in lazy.nvim spec
 {
     "clpi/down.nvim",
-    opts         = {
+    command = { "Down" },
+    keys = {
+        
+    }
+    lazy = false,
+    opts = {
       workspace = {
         default = "notes",
         workspaces = {
           notes = "~/notes",
-          personal = "~/home"
+          wiki = "~/wiki",
         }
       }
     },
     dependencies = {
       "nvim-treesitter/nvim-treesitter",
       "nvim-lua/plenary.nvim",
-      "MunifTanjim/nui.nvim",
-      "pysan3/pathlib.nvim",
-      "nvim-neotest/nvim-nio",
+
+        -- And an optional picker, if you want that functionality
       "nvim-telescope/telescope.nvim", -- optional
+      "folke/snacks.nvim",             -- optional
     },
 }
 ```

index.md

@@ -1,4 +1,3 @@
----@package down.nvim
 ---@brief v0.1.2-alpha
 ---@author Chris Pecunies <clp@clp.is>
 ---@repository https://github.com/clpi/down.nvim.git
@@ -11,7 +10,7 @@
 
 --- The main entry point for the down plugin
 ---@class down.Down
-Down = {
+local Down = {
   --- The configuration for the plugin
   config = require("down.config"),
   --- The module logic for the plugin
@@ -21,73 +20,70 @@ Down = {
   --- The utility logic for the plugin
   util = require("down.util"),
   --- The log logic for the plugin
-  log = require("down.util.log"),
+  log = require("down.log"),
 }
 
 --- Load the user configuration, and load into config
 --- defined modules specifieed and workspaces
---- @param user down.config.User user config to load
+--- @param user_config down.config.User user config to load
 --- @param ... string The arguments to pass into an optional user hook
-Down.setup = function(user, ...)
-  Down.util.log.trace("Setting up down")
-  Down.config:setup(user, ...)
+function Down:setup(user_config, ...)
+  Down.log.trace("Setting up down")
+  Down.config:setup(user_config, ...)
   Down:start()
 end
 
 --- *Start* the ^down.nvim^ plugin
 --- Load the workspace and user modules
 function Down:start()
-  self.util.log.trace("Setting up down")
-  self.mod.load_mod(
+  Down.log.trace("Setting up down")
+  Down.mod.load_mod(
     "workspace",
-    self.config.user.workspace or self.config.user.workspaces
+    Down.config.user.workspace or Down.config.user.workspaces
   )
-  for name, usermod in pairs(self.config.user) do
-    if self.mod.check_id(name) then
-      self.mod.load_mod(name, usermod)
+  for name, usermod in pairs(Down.config.user) do
+    if Down.mod.check_id(name) then
+      Down.mod.load_mod(name, usermod)
     end
   end
-  self:after()
+  Down:after()
 end
 
 --- After the plugin has started
 function Down:after()
-  self.config:after()
-  for _, l in pairs(self.mod.mods) do
-    self.event.load_callback(l)
+  Down.config:after()
+  for _, l in pairs(Down.mod.mods) do
+    Down.event.load_callback(l)
     l.after()
   end
-  self:broadcast("started")
+  Down:broadcast("started")
 end
 
 --- Broadcast the message `e` or the 'started' event to all modules
 ---@param e string
 ---@param ... any
 function Down:broadcast(e, ...)
-  local ev = self.event.define("down", e or "started") ---@type down.Event
-  self.event.broadcast_to(ev, Down.mod.mods)
+  local ev = Down.event.define("down", e or "started") ---@type down.Event
+  Down.event.broadcast_to(ev, Down.mod.mods)
 end
 
 --- Test all modules loaded
-function Down.test()
+function Down:test()
   Down.config:test()
   for m, d in pairs(Down.mod.mods) do
-    Down.util.log.trace("Testing mod: " .. m)
-    Down.util.log.trace("Result: " .. d.test())
+    Down.log.trace("Testing mod: " .. m)
+    Down.log.trace("Result: " .. d.test())
   end
 end
 
 return setmetatable(Down, {
   __call = function(down, user, ...)
     Down.setup(user, ...)
   end,
-  -- __call = function(down, user, ...)
-  --   down.setup(user, ...)
-  -- end,
-  -- __index = function(self, key)
+  -- __index = function(Down, key)
   --   return down.mod.mods[key]
   -- end,
-  -- __newindex = function(self, key, val)
+  -- __newindex = function(Down, key, val)
   --   down.mod.mods[key] = val
   -- end,
 })

lua/down.lua

@@ -1,4 +1,4 @@
-local log = require("down.util.log")
+local log = require("down.log")
 local mod = require("down.mod")
 local modconf = require("down.mod.util")
 
@@ -27,6 +27,30 @@ Config.toggles = {
   "bench",
 }
 
+--- Default keymaps for down.nvim, specified in user's config
+--- or to be loaded via a toggle
+Config.keys = {
+  { "<space>di", "<CMD>Down index<CR>", desc = "Down index" },
+  { "<space>dy", "<CMD>Down yesterday<CR>", desc = "Down yesterday" },
+  { "<space>dt", "<CMD>Down today<CR>", desc = "Down today" },
+  { "<space>dm", "<CMD>Down tomorrow<CR>", desc = "Down tomorrow" },
+  { "<space>dw", "<CMD>Down workspace<CR>", desc = "Down workspace" },
+  { "<space>dc", "<CMD>Down calendar<CR>", desc = "Down calendar" },
+  { "<space>df", "<CMD>Down find<CR>", desc = "Down find" },
+  { "<space>dn", "<CMD>Down note<CR>", desc = "Down note" },
+  { "<space>dp", "<CMD>Down note template<CR>", desc = "Down note template" },
+  { "<space>dd", "<CMD>Down<CR>", desc = "Down" },
+}
+
+--- Default dependencies for down.nvim, specified in user's config
+Config.dependencies = {
+  "nvim-lua/plenary.nvim",
+  "nvim-treesitter/nvim-treesitter",
+}
+
+--- Default command for down.nvim, specified in user's config
+Config.command = { "Down" }
+
 function Config:check_hook(...)
   if self.user.hook and type(self.user.hook) == "function" then
     return self.user.hook(...)
@@ -37,11 +61,11 @@ end
 ---@param v? boolean
 function Config:check_toggle(k, v)
   if
-      k
-      and type(k) == "string"
-      and v
-      and type(v) == "boolean"
-      and vim.tbl_contains(self.toggles, k)
+    k
+    and type(k) == "string"
+    and v
+    and type(v) == "boolean"
+    and vim.tbl_contains(self.toggles, k)
   then
     self[k] = v
   end
@@ -52,9 +76,11 @@ end
 ---@param ... any
 ---@return down.Config
 function Config:load(user, ...)
-  if self.started and self.started == false then
-    return self
-  elseif not type(user) == "table" then
+  if
+    (self.started and self.started == false)
+    or (not type(user) == "table")
+    or (type(user) == "nil")
+  then
     return self
   elseif user.defaults and user.defaults == false then
     self.user = user
@@ -139,12 +165,12 @@ end
 ---@return boolean
 function Config.check_mod_test(mod)
   return mod ~= nil
-      and mod.id ~= nil
-      and modconf.check_id(mod.id)
-      and type(mod) == "table"
-      and mod.tests ~= nil
-      and type(mod.tests) == "table"
-      and not vim.tbl_isempty(mod.tests)
+    and mod.id ~= nil
+    and modconf.check_id(mod.id)
+    and type(mod) == "table"
+    and mod.tests ~= nil
+    and type(mod.tests) == "table"
+    and not vim.tbl_isempty(mod.tests)
 end
 
 ---@param mods? down.Mod.Mod[]
@@ -161,20 +187,20 @@ end
 function Config.test(mod)
   vim.print("Testing " .. tostring(vim.inspect(mod.id)))
   return vim
-      .iter(pairs(mod.tests))
-      :filter(function(tn, t)
-        return tn and type(t) == "function"
-      end)
-      :all(function(tn, tt)
-        if not type(tt) == "function" then
-          return false
-        end
-        local res = tt(mod) or false ---@type boolean
-        vim.print(
-          "Testing mod " .. mod.id .. " test: " .. tn .. ": " .. tostring(res)
-        )
-        return res
-      end)
+    .iter(pairs(mod.tests))
+    :filter(function(tn, t)
+      return tn and type(t) == "function"
+    end)
+    :all(function(tn, tt)
+      if not type(tt) == "function" then
+        return false
+      end
+      local res = tt(mod) or false ---@type boolean
+      vim.print(
+        "Testing mod " .. mod.id .. " test: " .. tn .. ": " .. tostring(res)
+      )
+      return res
+    end)
 end
 
 return Config

lua/down/config.lua

@@ -1,4 +1,4 @@
-local log = require("down.util.log")
+local log = require("down.log")
 
 ---@class down.Event
 local Event = {

lua/down/event/init.lua

@@ -1,7 +1,7 @@
 local Event = require("down.event")
 local modutil = require("down.mod.util")
 local util = require("down.util")
-local log = util.log
+local log = log
 
 --- The Mod class is the core of the down plugin system. It is responsible for loading, unloading, and managing the lifecycle of all modules.
 ---@class down.mod.Root: down.Mod

lua/down/util/log/init.lua lua/down/log/init.lualua/down/util/log/init.lua renamed to lua/down/log/init.lua

@@ -1,5 +1,5 @@
 local down = require("down")
-local log = require("down.util.log")
+local log = require("down.log")
 local mod = require("down.mod")
 local util = require("down.util")
 local api, bo, fn = vim.api, vim.bo, vim.fn

lua/down/mod.lua

@@ -1,5 +1,5 @@
 local config = require("down.config")
-local log = require("down.util.log")
+local log = require("down.log")
 local mod = require("down.mod")
 local api, fn, fs, uv = vim.api, vim.fn, vim.fs, (vim.uv or vim.loop)
 local stdp, join = fn.stdpath, fs.joinpath

lua/down/mod/cmd/init.lua

@@ -1,7 +1,7 @@
 local mod = require("down.mod")
 local tbl = require("down.util.table")
 local util = require("down.util")
-local log = util.log
+local log = log
 local ts = vim.treesitter
 local tuok, tu = pcall(require, "nvim-treesitter.ts_utils")