updating readme, book, mod

clpi · Dec 15, 2024 · fd044b8 · fd044b8
1 parent e027062
commit fd044b8
Show file tree

Hide file tree

Showing 9 changed files with 70 additions and 43 deletions.
diff --git a/.luarc.json b/.luarc.json
@@ -1,6 +1,19 @@
 {
   "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
   "workspace.checkThirdParty": false,
+  "semantic.annotation": true,
+  "semantic.keyword": true,
+  "semantic.variable": true,
+  "hover.previewFields": 10,
+  "language.completeAnnotation": true,
+  "completion.autoRequire": true,
+  "completion.postfix": "@",
+  "signatureHelp": {
+    "enable": true
+  },
+  "addonManager": {
+    "enable": true
+  },
   "hover.enable": true,
   "addonManager.enable": true,
   "type.inferTableSize": 10,
@@ -25,8 +38,15 @@
   },
   "workspace.maxPreload": 1600,
   "workspace.preloadFileSize": 1000,
-  "diagnostics.unusedLocalExclude": ["_*"],
-  "diagnostics.globals": ["vim", "coroutine", "require", "bit"],
+  "diagnostics.unusedLocalExclude": [
+    "_*"
+  ],
+  "diagnostics.globals": [
+    "vim",
+    "coroutine",
+    "require",
+    "bit"
+  ],
   "diagnostics.disable": [
     "close-non-object",
     "deprecated",

diff --git a/.stylua.toml b/.stylua.toml
@@ -4,5 +4,6 @@ indent_type = "Spaces"
 indent_width = 2
 quote_style = "AutoPreferDouble"
 no_call_parentheses = false
+
 [sort_requires]
 enabled = true
diff --git a/README.md b/README.md
@@ -1,14 +1,16 @@
-# down.lua - the _familiar_, organized future for neovim
+# down.lua 
+
+### the _familiar_, organized future for neovim
 
 <a href="https://neovim.io"> ![Neovim](https://img.shields.io/badge/Neovim%200.10+-brightgreen?style=for-the-badge) </a>
-<a href="/LICENSE"> ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)</a>
+<a href="./LICENSE"> ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)</a>
 ![LuaRocks](https://img.shields.io/luarocks/v/clpi/down.lua)
 
 ---
 
-> [!Important]
+> [!Caution]
 >
-> `down.lua` is **BEGINNING DEVELOPMENT**
+> `down.lua` is currently in **early** *ongoing* development.
 
 <!--toc:start-->
 
@@ -43,36 +45,39 @@
 
 <details open>
   <summary>
-<a href="#">lazy.nvim</a>
+<a href="https://github.com/folke/lazy.nvim">lazy.nvim</a>
   </summary>
 
 ```lua
+-- Place in lazy.nvim spec
 {
     "clpi/down.lua",
-    lazy    = false,
-    version = "*"
-    branch  = "master",
-    config = function(_, opts)
-      require("down").setup({
+    version      = "*",
+    lazy         = false,
+    branch       = "master",
+    config       = function()
+      require "down".setup {
         mod = {
-          config = {},
           workspace = {
             config = {
+              default = "notes",
               workspaces = {
                 default = "~/down",
-                notes = "~/notes"
+                notes = "~/notes",
+                personal = "~/home"
               }
             }
           }
         }
-      })
+      }
     end,
     dependencies = {
+      "nvim-treesitter/nvim-treesitter",
       "nvim-lua/plenary.nvim",
       "MunifTanjim/nui.nvim",
       "pysan3/pathlib.nvim",
       "nvim-telescope/telescope.nvim", -- optional
-    }
+    },
 }
 ```
 
@@ -83,7 +88,7 @@
 <details>
 
   <summary>
-<a href="#">plug.vim</a>
+<a href="https://github.com/junegunn/vim-plug">plug.vim</a>
   </summary>
 
 > [!Caution]
@@ -100,11 +105,11 @@ Plug "clpi/down.lua", {
     \ "branch" : "master",
     \ "do"     : ':lua require([[down]]).setup({
     \   mod = {
-    \     config = {},
     \     workspace = {
     \       config = {
     \         workspaces = {
-    \           default = [[~/wiki]],
+    \           wiki = [[~/wiki]],
+    \           default = [[~/down]],
     \           notes = [[~/notes]]
     \         }
     \       }
@@ -119,7 +124,7 @@ Plug "clpi/down.lua", {
 ---
 
 <details>
-<summary><a href="#">Vundle</a></summary>
+<summary><a href="https://github.com/VundleVim/Vundle.vim">Vundle</a></summary>
 
 > [!Caution]
 >
@@ -140,7 +145,7 @@ Plugin 'clpi/down.lua'
 <details>
 
   <summary>
-<a href="#">dein.vim</a>
+<a href="https://github.com/Shougo/dein.vim">dein.vim</a>
   </summary>
 
 > [!Caution]
@@ -162,7 +167,7 @@ call dein#add('clpi/down.lua')
 <details>
 
   <summary>
-<a href="#">packer.nvim</a>
+<a href="https://github.com/wbthomason/packer.nvim">packer.nvim</a>
   </summary>
 
 > [!Caution]
@@ -183,10 +188,11 @@ use {
   config = function()
       require("down").setup({
         mod = {
-          config = {},
           workspace = {
             config = {
               workspaces = {
+                default = "~/down",
+                home = "~/notes",
                 notes = "~/notes"
               }
             }
@@ -204,7 +210,7 @@ use {
 <details>
 
   <summary>
-<a href="#">mini.deps</a>
+<a href="https://github.com/echasnovski/mini.deps">mini.deps</a>
   </summary>
 
 > [!Caution]
@@ -245,13 +251,13 @@ use {
 -- and make it default
 require("down").setup({ ---@type down.mod.Config
   mod = {
-    config = {},
     workspace = {
       config = {
         default = 'home',
         workspaces = {
-          notes = "~/notes",
-          home = "~/notes"
+          default = "~/down",
+          home = "~/notes",
+          notes = "~/notes"
         }
       }
     }

diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -50,12 +50,15 @@ Welcome -- to the `down.lua` book. I hope this helps!
 
   - [Frameworks](./publish/frameworks.md)
   - [Blog](./publish/blog.md)
+  - [Wiki](./publish/wiki.md)
   - [Digital garden](./publish/digital_garden.md)
 
 - [Plans](./plans/index.md)
 
-  - [Near](./plans/near.md)
-  - [Far](./plans/far.md)
+  - [Short-term](./plans/near.md)
+  - [Long-term](./plans/far.md)
+  - [General](./plans/general.md)
+  - [Todo](./plans/todo.md)
 
 - [Support](./support.md)
 

diff --git a/book/src/plans/general.md b/book/src/plans/general.md
diff --git a/down-scm-1.rockspec b/down-scm-1.rockspec
@@ -111,9 +111,9 @@ build = {
   modules = {},
   install = {
     bin = {
-      downls = "scripts/bin/downls",
-      down_lsp = "scripts/bin/down-lsp",
-      down = "scripts/bin/down",
+      downls = "./scripts/bin/down-lsp.sh",
+      down_lsp = "./scripts/bin/down-lsp",
+      down = "./scripts/bin/down",
     },
   },
   copy_directories = {

diff --git a/lua/down/config.lua b/lua/down/config.lua
@@ -4,8 +4,9 @@ local f = vim.fn
 
 --- @type down.Config
 C.config = {
-  ---@type down.config.UserMod
+  ---@class down.config.User
   user = {
+    ---@class down.config.UserMod
     mod = {
       config = {},
     },

diff --git a/lua/down/health.lua b/lua/down/health.lua
@@ -1,15 +1,15 @@
 local H = {}
 
 local h = vim.health
-local ok,err,warn=h.ok,h.error,h.warn
+local ok, err, warn = h.ok, h.error, h.warn
 
 H.check = function()
   h.start "checking config"
-  local c = require "down.mod.config".config
-  if c == nil then
-    err "config is nil"
+  local c = require "down.config".config
+  if c ~= nil then
+    ok("config is not nil" .. #c.user.mod .. #c.mod)
   else
-    ok "config not nil"
+    err("config is nil" .. "")
   end
 end
 

diff --git a/lua/down/mod.lua b/lua/down/mod.lua
@@ -64,11 +64,7 @@ Mod.default = function(name)
       --TODO: remove
       data = {},
     },
-    config = {
-      private = {},
-      custom = {},
-      public = {},
-    },
+    config = {},
     events = {
       subscribed = { -- The events that the init is subscribed to
       },