adding docs, adding icon logic

Author: clpi

TODO.md

@@ -1,5 +1,12 @@
 # Todo
 
+## High priority
+
+### New features
+
+- [ ] Implement `bookmark` mod
+- [ ] Implement `date` and `time` completion insert
+
 ## Project Maintenance
 
 - [ ] Implement CI/CD for the project

doc/down.txt

@@ -1,6 +1,6 @@
 local log = require("down.util.log")
 local mod = require("down.mod")
-local modconf = require("down.util.mod")
+local modconf = require("down.mod.util")
 
 --- The down.nvim configuration
 --- @class down.config.Config

lua/down/config.lua

@@ -4,45 +4,43 @@ local h = vim.health
 local start = vim.health.start
 local ok, err, warn = h.ok, h.error, h.warn
 
-H.mod = function()
-  if require('down.config').mod == nil then
-    h.error 'config.mod is nil'
+H.user = function()
+  if require("down.config").user == nil then
+    h.error("config.mod is nil")
   else
-    h.ok 'config.mod is not nil'
+    h.ok("config.mod is not nil")
   end
 end
 
 H.workspace = function()
-  if require('down.config').mod.workspace.config.workspaces == nil then
-    h.error 'config.mod.workspace.workspaces is nil'
+  if require("down.config").user.workspace.config.workspaces == nil then
+    h.error("config.mod.workspace.workspaces is nil")
   else
-    h.ok 'config.mod.workspace.workspaces is not nil'
-  end
-end
-
-H.user = function()
-  if require('down.config').user == nil then
-    h.error 'config.user is nil'
-  else
-    h.ok 'config.user is not nil'
+    h.ok("config.mod.workspace.workspaces is not nil")
   end
 end
 
 H.deps = {
-  ['nvim-treesitter'] = 'nvim-treesitter/nvim-treesitter',
-  ['plenary.nvim'] = 'nvim-lua/plenary.nvim',
-  ['dressing.nvim'] = 'stevearc/dressing.nvim',
-  ['nui.nvim'] = "MunifTanjim/nui.nvim"
+  ["nvim-treesitter"] = "nvim-treesitter/nvim-treesitter",
+  ["plenary.nvim"] = "nvim-lua/plenary.nvim",
+  ["nui.nvim"] = "MunifTanjim/nui.nvim",
 }
 
 H.optional = {
-  ['telescope.nvim'] = 'nvim-telescope/telescope.nvim',
+  ["telescope.nvim"] = "nvim-telescope/telescope.nvim",
   ["nvim-web-devicons"] = "kyazdani42/nvim-web-devicons",
-  ["mini.icons"] = "wuelnerdotexe/mini.icons"
+  ["mini.icons"] = "wuelnerdotexe/mini.icons",
 }
 
+---@param i? down.mod.ui.icon.Provider.Name
+H.has_icon_provider = function(i)
+  if require("down.mod.ui.icon.util").has_provider(i) then
+    return h.ok("Icon provider is available")
+  end
+end
+
 H.check_dep = function(dep)
-  local lazyok, lazy = pcall(require, 'lazy.core.config')
+  local lazyok, lazy = pcall(require, "lazy.core.config")
   if lazyok then
     return lazy.plugins[dep] ~= nil
   else
@@ -51,35 +49,36 @@ H.check_dep = function(dep)
 end
 
 H.check_optional = function()
-  if H.check_dep('telescope.nvim') then
-    h.ok(H.optional['telescope.nvim'] .. ' is installed')
+  if H.check_dep("telescope.nvim") then
+    h.ok(H.optional["telescope.nvim"] .. " is installed")
   else
-    h.warn(H.optional['telescope.nvim'] .. ' is not installed')
+    h.warn(H.optional["telescope.nvim"] .. " is not installed")
   end
-  if H.check_dep('nvim-web-devicons')
-      or H.check_dep('mini.icons') then
-    h.warn(H.optional['mini.icons'] .. ' is not installed')
+  if H.check_dep("nvim-web-devicons") or H.check_dep("mini.icons") then
+    h.warn(H.optional["mini.icons"] .. " is not installed")
   else
-    h.warn(H.optional['mini.icons'] or H.optional['nvim-web-devicons'] .. ' is not installed')
+    h.warn(
+      H.optional["mini.icons"]
+        or H.optional["nvim-web-devicons"] .. " is not installed"
+    )
   end
 end
 
 H.check_req = function()
   for dep, repo in pairs(H.deps) do
     if H.check_dep(dep) then
-      h.ok(dep .. ' is installed')
+      h.ok(dep .. " is installed" .. repo)
     else
-      h.error(dep .. ' is not installed')
+      h.error(dep .. " is not installed" .. repo)
     end
   end
 end
 
 H.check = function()
-  h.start 'down.nvim'
+  h.start("down.nvim")
   H.check_optional()
   H.check_req()
   H.user()
-  H.mod()
   H.workspace()
 end
 

lua/down/health.lua

@@ -1,5 +1,5 @@
 local Event = require("down.event")
-local modutil = require("down.util.mod")
+local modutil = require("down.mod.util")
 local util = require("down.util")
 local log = util.log