update: Makefile, README.md, tags, wf.txt, bookmark.lua, buffer.lua, …

…register.lua, which_key.lua, init.lua, mini.lua,

Makefile

@@ -20,7 +20,7 @@ test-ci: deps test
 
 # generates the documentation.
 documentation:
-	nvim --headless --noplugin -u ./scripts/minimal_init.lua -c "lua require('mini.doc').generate(require(\"wf.mini\").setup)" -c "qa!"
+	nvim --headless --noplugin -u ./scripts/minimal_init.lua -c "lua require('mini.doc').generate(require(\"wf.mini\").input())" -c "qa!"
 
 # installs deps before running the documentation generation, useful for the CI.
 documentation-ci: deps documentation

README.md

@@ -184,10 +184,10 @@ vim.keymap.set(
 
 -- Buffer
 vim.keymap.set(
-    "n",
-    "<Space>wbu",
-    buffer({}),
-    {noremap = true, silent= true, desc = "[wf.nvim] buffer"}
+  "n",
+  "<Space>wbu",
+  buffer({}),
+  {noremap = true, silent= true, desc = "[wf.nvim] buffer"}
 )
 
 -- Which Key

doc/tags

@@ -1,5 +1,6 @@
-bookmark()	wf.txt	/*bookmark()*
-buffer()	wf.txt	/*buffer()*
-register()	wf.txt	/*register()*
+builtin.bookmark	wf.txt	/*builtin.bookmark*
+builtin.buffer	wf.txt	/*builtin.buffer*
+builtin.register	wf.txt	/*builtin.register*
+builtin.which_key	wf.txt	/*builtin.which_key*
 select()	wf.txt	/*select()*
-which_key()	wf.txt	/*which_key()*
+wf.nvim	wf.txt	/*wf.nvim*

doc/wf.txt

@@ -1,6 +1,22 @@
 ==============================================================================
 ------------------------------------------------------------------------------
-                                                                    *bookmark()*
+                                                                       *wf.nvim*
+A modern which-key for neovim
+
+------------------------------------------------------------------------------
+                                                                      *select()*
+                     `select`({items}, {opts}, {on_choice})
+Parameters~
+{items} items
+{opts} the options for wf
+{on_choice} a callback that will be carried
+Usage~
+`require("wf").select(items, opts, on_choice)`
+
+
+==============================================================================
+------------------------------------------------------------------------------
+                                                              *builtin.bookmark*
                       `bookmark`({bookmark_dirs}, {opts})
 Parameters~
 {bookmark_dirs} `(table)`
@@ -9,38 +25,26 @@ Parameters~
 
 ==============================================================================
 ------------------------------------------------------------------------------
-                                                                      *buffer()*
+                                                                *builtin.buffer*
                                 `buffer`({opts})
 Parameters~
 {opts} `(optional)` `(table)`
 
 
 ==============================================================================
 ------------------------------------------------------------------------------
-                                                                    *register()*
+                                                              *builtin.register*
                                `register`({opts})
 Parameters~
 {opts} `(optional)` `(table)`
 
 
 ==============================================================================
 ------------------------------------------------------------------------------
-                                                                   *which_key()*
+                                                             *builtin.which_key*
                               `which_key`({opts})
 Parameters~
 {opts} `(optional)` `(table)`
 
 
-==============================================================================
-------------------------------------------------------------------------------
-                                                                      *select()*
-                     `select`({items}, {opts}, {on_choice})
-Parameters~
-{items} items
-{opts} the options for wf
-{on_choice} a callback that will be carried
-Usage~
-`require("wf").select(items, opts, on_choice)`
-
-
  vim:tw=78:ts=8:noet:ft=help:norl:

lua/wf/builtin/bookmark.lua

@@ -7,6 +7,7 @@ end
 
 local ok, devicon = pcall(require_deviocon)
 
+---@tag builtin.bookmark
 ---@param bookmark_dirs table
 ---@param opts? table
 local function bookmark(bookmark_dirs, opts)

lua/wf/builtin/buffer.lua

@@ -20,6 +20,7 @@ local function get_active_buffers()
   return res, bs
 end
 
+---@tag builtin.buffer
 ---@param opts? table
 local function buffer(opts)
   local function _buffer()

lua/wf/builtin/register.lua

@@ -20,6 +20,7 @@ local types = {
   [""] = "u",
 }
 
+---@tag builtin.register
 ---@param opts? table
 local function register(opts)
   local function _register()

lua/wf/builtin/which_key.lua

@@ -76,6 +76,7 @@ local function feedkeys(lhs, count, caller, noremap)
   end
 end
 
+---@tag builtin.which_key
 ---@param opts? table
 local function which_key(opts)
   local core = function()

lua/wf/init.lua

@@ -1,3 +1,9 @@
+-- MIT License Copyright (c) 2022 Cassin01
+
+-- Documentation ==============================================================
+--- A modern which-key for neovim
+---@tag wf.nvim
+
 local util = require("wf.util")
 local au = util.au
 local rt = util.rt

lua/wf/mini.lua

@@ -5,7 +5,7 @@ H.input = function()
   -- Search in current and recursively in other directories for files with
   -- 'lua' extension
   local res = {}
-  for _, dir_glob in ipairs({ ".", "lua/**", "after/**", "colors/**", "lua/builtin/**" }) do
+  for _, dir_glob in ipairs({ ".", "lua/**", "after/**", "colors/**" }) do
     local files = vim.fn.globpath(dir_glob, "*.lua", false, true)
 
     -- Use full paths
@@ -22,9 +22,11 @@ H.input = function()
         if vim.fn.fnamemodify(b, ":t") == "init.lua" then
           return false
         end
+        return a < b
+      else
+        return vim.fn.fnamemodify(a, ":h") < vim.fn.fnamemodify(b, ":h")
       end
 
-      return a < b
     end)
     table.insert(res, files)
   end