feat: search words using K

Implemented keywordprg. Close #55 and #48.

Author: luckasRanarison

lua/nvim-devdocs/init.lua

@@ -62,6 +62,16 @@ M.update_all = function()
   end
 end
 
+M.keywordprg = function(args)
+  local keyword = args.fargs[1]
+
+  if keyword then
+    operations.keywordprg(keyword)
+  else
+    notify.log("No keyword provided")
+  end
+end
+
 M.setup = function(opts)
   config.setup(opts)
 
@@ -78,6 +88,7 @@ M.setup = function(opts)
   cmd("DevdocsOpenFloat", M.open_doc_float, { nargs = "?", complete = completion.get_installed })
   cmd("DevdocsOpenCurrent", function() M.open_doc_current_file() end, {})
   cmd("DevdocsOpenCurrentFloat", function() M.open_doc_current_file(true) end, {})
+  cmd("DevdocsKeywordprg", M.keywordprg, { nargs = "?" })
   cmd("DevdocsUpdate", M.update, { nargs = "*", complete = completion.get_updatable })
   cmd("DevdocsUpdateAll", M.update_all, {})
 end

lua/nvim-devdocs/operations.lua

@@ -180,6 +180,20 @@ M.get_all_entries = function()
   return entries
 end
 
+M.read_entry = function(entry, callback)
+  local splited_path = vim.split(entry.path, ",")
+  local file = splited_path[1]
+  local file_path = DOCS_DIR:joinpath(entry.alias, file .. ".md")
+
+  file_path:_read_async(vim.schedule_wrap(function(content)
+    local pattern = splited_path[2]
+    local lines = vim.split(content, "\n")
+    local filtered_lines = M.filter_doc(lines, pattern)
+
+    callback(filtered_lines)
+  end))
+end
+
 -- if we have a pattern to search for, only consider lines after the pattern
 M.filter_doc = function(lines, pattern)
   if not pattern then return lines end
@@ -245,6 +259,7 @@ M.open = function(entry, bufnr, float)
 
     float_opts.row = plugin_config.row or row
     float_opts.col = plugin_config.col or col
+    float_opts.zindex = 10
 
     local win = nil
     local last_win = state.get("last_win")
@@ -271,8 +286,35 @@ M.open = function(entry, bufnr, float)
     vim.bo[bufnr].ft = "markdown"
   end
 
+  vim.bo[bufnr].keywordprg = ":DevdocsKeywordprg"
+
   config.set_keymaps(bufnr, entry)
   plugin_config.after_open(bufnr)
 end
 
+M.keywordprg = function(keyword)
+  local alias = state.get("current_doc")
+  local float = state.get("last_mode") == "float"
+  local bufnr = state.get("last_bufnr")
+  local entries = M.get_entries(alias)
+  local entry
+
+  local function callback(filtered_lines)
+    vim.bo[bufnr].modifiable = true
+    vim.api.nvim_buf_set_lines(bufnr, 0, -1, true, filtered_lines)
+    vim.bo[bufnr].modifiable = false
+
+    M.open(entry, bufnr, float)
+  end
+
+  for _, value in pairs(entries or {}) do
+    if value.name == keyword or value.link == keyword then
+      entry = value
+      M.read_entry(entry, callback)
+    end
+  end
+
+  if not entry then notify.log("No documentation found for " .. keyword) end
+end
+
 return M

lua/nvim-devdocs/pickers.lua

@@ -50,16 +50,9 @@ local doc_previewer = previewers.new_buffer_previewer({
   title = "Preview",
   keep_last_buf = true,
   define_preview = function(self, entry)
-    local splited_path = vim.split(entry.value.path, ",")
-    local file = splited_path[1]
-    local file_path = DOCS_DIR:joinpath(entry.value.alias, file .. ".md")
     local bufnr = self.state.bufnr
-    local pattern = splited_path[2]
-
-    file_path:_read_async(vim.schedule_wrap(function(content)
-      local lines = vim.split(content, "\n")
-      local filtered_lines = operations.filter_doc(lines, pattern)
 
+    operations.read_entry(entry.value, function(filtered_lines)
       vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, filtered_lines)
 
       if plugin_config.previewer_cmd and plugin_config.picker_cmd then
@@ -68,13 +61,12 @@ local doc_previewer = previewers.new_buffer_previewer({
       else
         vim.bo[bufnr].ft = "markdown"
       end
-    end))
+    end)
   end,
 })
 
-local open_doc = function(float)
+local open_doc = function(selection, float)
   local bufnr = nil
-  local selection = action_state.get_selected_entry()
 
   if plugin_config.picker_cmd then
     bufnr = vim.api.nvim_create_buf(false, true)
@@ -84,6 +76,8 @@ local open_doc = function(float)
     bufnr = state.get_global_key("last_preview_bufnr")
   end
 
+  plugin_state.set("last_bufnr", bufnr)
+  plugin_state.set("last_mode", float and "float" or "normal")
   operations.open(selection.value, bufnr, float)
 end
 
@@ -163,7 +157,14 @@ M.open_picker = function(entries, float)
     attach_mappings = function()
       actions.select_default:replace(function(prompt_bufnr)
         actions.close(prompt_bufnr)
-        open_doc(float)
+
+        local selection = action_state.get_selected_entry()
+        local name = selection.value.name
+        local match = name:match("%[([^%]]+)%]")
+
+        if match then plugin_state.set("current_doc", match) end
+
+        open_doc(selection, float)
       end)
       return true
     end,
@@ -178,6 +179,7 @@ M.open_picker_alias = function(alias, float)
   if not entries then
     notify.log_err(alias .. " documentation is not installed")
   else
+    plugin_state.set("current_doc", alias)
     M.open_picker(entries, float)
   end
 end

lua/nvim-devdocs/state.lua

@@ -1,8 +1,11 @@
 local M = {}
 
 local state = {
+  current_doc = nil, -- ex: "javascript", used for `keywordprg`
   preview_lines = nil,
   last_win = nil,
+  last_bufnr = nil,
+  last_mode = nil, -- "normal" | "float"
 }
 
 ---@return any