updating doc, updating mod names, moving mods

Author: clpi

doc/down.txt

@@ -1,31 +1,42 @@
----@author clpi
----@file down.nvim 0.1.0
----@license MIT
 ---@package down.nvim
----@brief neovim note-taking plugin with the
----@brief comfort of mmarkdown and the power of org
+---@brief v0.1.2-alpha
+---@author Chris Pecunies <clp@clp.is>
+---@repository https://github.com/clpi/down.nvim.git
+---@homepage https://down.cli.st
+---@license MIT
+---@tags markdown, org-mode, note-taking, knowledge-management, developer-tools, productivity
+---
+---@brief The Neovim plugin for the *down* _markdown_ developer-focused
+---@briefnote-taking and knowledge management environment, offering the comfort familiarity, and compatibility of a traditional markdown note-taking environment with the power of org-mode.
 
----@class down.down
-local down = {
-  ---@type down.config.Config
+--- The main entry point for the down plugin
+---@class down.Down
+local Down = {
+  --- The configuration for the plugin
   config = require("down.config"),
+  --- The module logic for the plugin
   mod = require("down.mod"),
+  --- The event logic for the plugin
   event = require("down.event"),
+  --- The utility logic for the plugin
   util = require("down.util"),
+  --- The log logic for the plugin
   log = require("down.util.log"),
 }
 
 --- Load the user configuration, and load into config
 --- defined modules specifieed and workspaces
---- @param user down.mod.Config user config to load
+--- @param user down.config.User user config to load
 --- @param ... string The arguments to pass into an optional user hook
-function down.setup(user, ...)
-  down.util.log.trace("Setting up down")
-  down.config:setup(user, ...)
-  down:start()
+Down.setup = function(user, ...)
+  Down.util.log.trace("Setting up down")
+  Down.config:setup(user, ...)
+  Down:start()
 end
 
-function down:start()
+--- Start the plugin
+--- Load the workspace and user modules
+function Down:start()
   self.util.log.trace("Setting up down")
   self.mod.load_mod(
     "workspace",
@@ -36,35 +47,40 @@ function down:start()
       self.mod.load_mod(name, usermod)
     end
   end
-  self:post_load()
+  self:after()
 end
 
-function down:post_load()
-  self.config:post_load()
+--- After the plugin has started
+function Down:after()
+  self.config:after()
   for _, l in pairs(self.mod.mods) do
     self.event.load_cb(l)
-    l.post_load()
+    l.after()
   end
   self:broadcast("started")
 end
 
+--- Broadcast the message `e` or the 'started' event to all modules
 ---@param e string
 ---@param ... any
-function down:broadcast(e, ...)
+function Down:broadcast(e, ...)
   local ev = self.event.define("down", e or "started") ---@type down.Event
-  self.event.broadcast_to(ev, down.mod.mods)
+  self.event.broadcast_to(ev, Down.mod.mods)
 end
 
 --- Test all modules loaded
-function down.test()
-  down.config:test()
-  for m, d in pairs(down.mod.mods) do
-    print("Testing mod: " .. m)
-    d.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())
   end
 end
 
-return setmetatable(down, {
+return setmetatable(Down, {
+  __call = function(down, user, ...)
+    Down.setup(user, ...)
+  end,
   -- __call = function(down, user, ...)
   --   down.setup(user, ...)
   -- end,

lua/down.lua

@@ -3,7 +3,7 @@ local mod = require("down.mod")
 local modconf = require("down.mod.util")
 
 --- The down.nvim configuration
---- @class down.config.Config
+--- @class down.Config
 local Config = {
   --- Start in dev mode
   dev = false,
@@ -37,19 +37,20 @@ 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
 end
 
+--- Load the user configuration, and load into config
 ---@param user down.mod.Config user config
 ---@param ... any
----@return down.config.Config
+---@return down.Config
 function Config:load(user, ...)
   if self.started and self.started == false then
     return self
@@ -67,7 +68,7 @@ function Config:load(user, ...)
   self.started = true
 end
 
-function Config:post_load()
+function Config:after()
   return self:check_tests(require("down.mod").mods or self.user) ---@type boolean?
 end
 
@@ -109,10 +110,11 @@ function Config:save(f)
   return vim.fn.writefile(json, self:file(f), "S")
 end
 
---- @param self down.config.Config
----@param user down.mod.Config
----@param ... any
----@return down.config.Config
+--- Setup the down config
+--- @param self down.Config The down config
+--- @param user down.mod.Config user config to load
+--- @param ... any The arguments to pass into an optional user hook
+--- @return down.Config
 function Config:setup(user, ...)
   log.new(log.config, false)
   log.info("Config.setup: Log started")
@@ -137,12 +139,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[]
@@ -159,20 +161,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,15 +1,15 @@
-local log = require 'down.util.log'
+local log = require("down.util.log")
 
 ---@class down.Event
 local Event = {
   autocmd = require("down.event.autocmd"),
-  id = '',
-  ref = '',
+  id = "",
+  ref = "",
   split = {},
   body = nil,
   broadcast = true,
   position = vim.api.nvim_win_get_cursor(0),
-  file = vim.fn.expand('%:p'),
+  file = vim.fn.expand("%:p"),
   dir = vim.fn.getcwd(),
   buf = vim.api.nvim_get_current_buf(),
   win = vim.api.nvim_get_current_win(),
@@ -25,11 +25,11 @@ local Event = {
     },
     line = vim.api.nvim_get_current_line(),
     char = vim.api.nvim_win_get_cursor(0)[2],
-    file = vim.fn.expand('%:p'),
+    file = vim.fn.expand("%:p"),
     buf = vim.api.nvim_get_current_buf(),
     win = vim.api.nvim_get_current_win(),
     dir = vim.fn.getcwd(),
-    scope = 'global',
+    scope = "global",
   },
 }
 
@@ -82,7 +82,7 @@ end
 function Event.load_cb(m)
   for hk, ht in pairs(m.handle) do
     for ck, ct in pairs(ht) do
-      if type(ct) == 'function' then
+      if type(ct) == "function" then
         Event.callback(Event.define(m, ck), ct)
       end
     end
@@ -92,21 +92,21 @@ end
 ---@type fun(module: down.Mod.Mod, name: string, body?: any): down.Event
 ---@return down.Event
 Event.define = function(module, name, body)
-  local mn = ''
-  if type(module) == 'table' then
+  local mn = ""
+  if type(module) == "table" then
     mn = module.id
-  elseif type(module) == 'string' then
+  elseif type(module) == "string" then
     mn = module
   end
-  local id = mn .. '.events.' .. name
+  local id = mn .. ".events." .. name
   return { ---@type down.Event
     id = id,
     ref = mn,
     split = Event.split_id(id) or {},
     body = body or module,
     broadcast = true,
     position = vim.api.nvim_win_get_cursor(0),
-    file = vim.fn.expand('%:p'),
+    file = vim.fn.expand("%:p"),
     dir = vim.fn.getcwd(),
     line = vim.api.nvim_get_current_line(),
     buf = vim.api.nvim_get_current_buf(),
@@ -119,10 +119,10 @@ end
 --- @param id string The full path of a init event
 --- @return string[]?
 function Event.split_id(id)
-  local sa, sb = id:find('%.events%.')
+  local sa, sb = id:find("%.events%.")
   local sp_id = { id:sub(0, sa - 1), id:sub(sb + 1) }
   if #sp_id ~= 2 then
-    log.warn('Invalid type name:' .. id)
+    log.warn("Invalid type name:" .. id)
     return
   end
   return sp_id
@@ -135,10 +135,12 @@ end
 function Event.get_event(m, id)
   local split = Event.split_id(id)
   if not split then
-    log.warn('Unable to get event template for event' .. id .. 'and init' .. m.id)
+    log.warn(
+      "Unable to get event template for event" .. id .. "and init" .. m.id
+    )
     return
   end
-  log.trace('Returning' .. split[2] .. 'for init' .. split[1])
+  log.trace("Returning" .. split[2] .. "for init" .. split[1])
   return m.events[split[2]]
 end
 
@@ -151,40 +153,48 @@ end
 function Event.new(m, id, body, ev)
   local event_template = Event.get_event(m or { id = m.id }, id)
   if not event_template then
-    log.warn('Unable to create event of type' .. id .. '. Returning nil...')
+    log.warn("Unable to create event of type" .. id .. ". Returning nil...")
     return
   end
   local mn = vim.deepcopy(event_template)
   mn.id = id
   mn.body = body
   mn.ref = m.id
   mn.split = assert(Event.split_id(id))
-  mn.file = vim.fn.expand('%:t') --[[@as string]]
-  mn.dir = vim.fn.expand('%:p:h') --[[@as string]]
+  mn.file = vim.fn.expand("%:t") --[[@as string]]
+  mn.dir = vim.fn.expand("%:p:h") --[[@as string]]
   mn.buf = ev and ev.buf or vim.api.nvim_get_current_buf()
   mn.win = vim.api.nvim_get_current_win()
   mn.position = vim.api.nvim_win_get_cursor(mn.win)
   mn.mode = vim.api.nvim_get_mode()
-  mn.line = vim.api.nvim_buf_get_lines(mn.buf, mn.position[1] - 1, mn.position[1], true)[1]
+  mn.line = vim.api.nvim_buf_get_lines(
+    mn.buf,
+    mn.position[1] - 1,
+    mn.position[1],
+    true
+  )[1]
   mn.broadcast = true
   return mn
 end
 
 --- Sends an event to all subscribed mod. The event contains the filename, filehead, cursor position and line body as a bonus.
 --- @param mods down.Mod.Mod[]
 --- @param self down.Event
+--- @return nil
 function Event.broadcast_to(self, mods)
   if not self.split then
-    log.error('Unable to broadcast event of type' .. self.id .. '- invalid event name')
+    log.error(
+      "Unable to broadcast event of type" .. self.id .. "- invalid event name"
+    )
     return
   end
   Event.handle(self)
   for mid, cm in pairs(mods or {}) do
     if cm.handle and cm.handle[self.split[1]] then
       local evt = cm.handle[self.split[1]][self.split[2]]
-      if evt == nil or type(evt) == 'nil' then
+      if evt == nil or type(evt) == "nil" then
         goto broadcastcontinue
-      elseif type(evt) == 'function' then
+      elseif type(evt) == "function" then
         evt(self)
       end
     end
@@ -200,7 +210,7 @@ function Event.send(self, recv)
   Event.handle(self)
   if recv.handle and recv.handle[self.split[1]] then
     local evt = recv.handle[self.split[1]][self.split[2]]
-    if evt ~= nil and type(evt) == 'function' then
+    if evt ~= nil and type(evt) == "function" then
       evt(self)
     end
   end