Merge branch 'main' into partial-matching

Author: hc-nolan

README.md

@@ -44,11 +44,20 @@ return {
     'nvim-telescope/telescope.nvim', -- or, 'folke/snacks.nvim'
   },
   cmd = { 'ApidocsSearch', 'ApidocsInstall', 'ApidocsOpen', 'ApidocsSelect', 'ApidocsUninstall' },
+  -- If using ensure_installed (see below), uncomment the next line to trigger the
+  -- installation when Neovim is opened
+  -- lazy = false
   config = function()
-    require('apidocs').setup()
-    -- Picker will be auto-detected. To select a picker of your choice explicitly you can set picker by the configuration option 'picker':
-    -- require('apidocs').setup({picker = "snacks"})
-    -- Possible options are 'ui_select', 'telescope', and 'snacks'
+    local opts = {
+      -- Picker will be auto-detected. To select a picker of your choice explicitly you can set picker by the configuration option 'picker':
+      -- Possible options are 'ui_select', 'telescope', and 'snacks'
+      picker = "telescope",
+      -- Use the below to make sure documentations for your languages are installed
+      -- Note: best used with `lazy = false` (see above)
+      -- ensure_installed = { "lua~5.4" }
+
+    }
+    require('apidocs').setup(opts)
   end,
   keys = {
     { '<leader>sad', '<cmd>ApidocsOpen<cr>', desc = 'Search Api Doc' },

lua/apidocs.lua

@@ -3,6 +3,50 @@ local install = require("apidocs.install")
 
 Config = {}
 
+local function get_installed_docs(fs, opts)
+  local installed_docs = {}
+  if fs == nil then
+    return installed_docs
+  end
+  while true do
+    local name, type = vim.uv.fs_scandir_next(fs)
+    if not name then
+      break
+    end
+    if type == "directory" then
+      if opts and opts.restrict_sources then
+        for _, source in ipairs(opts.restrict_sources) do
+          if name:match("^" .. source) then
+            table.insert(installed_docs, name)
+          end
+        end
+      else
+        table.insert(installed_docs, name)
+      end
+    end
+  end
+  return installed_docs
+end
+
+local function ensure_installed(opts)
+  local docs_path = common.data_folder()
+  local fs = vim.uv.fs_scandir(docs_path)
+  local installed_docs = get_installed_docs(fs, opts)
+  if opts and opts.ensure_installed then
+    for _, source in ipairs(opts.ensure_installed) do
+      if not vim.tbl_contains(installed_docs, source) then
+        if slugs_to_mtimes == nil then
+          install.fetch_slugs_and_mtimes_and_then(function(slugs_to_mtimes)
+            install.apidoc_install(source, slugs_to_mtimes)
+          end)
+        else
+          install.apidoc_install(source, slugs_to_mtimes)
+        end
+      end
+    end
+  end
+end
+
 local function set_picker(opts)
   if opts and (opts.picker == "snacks" or opts.picker == "telescope" or opts.picker == "ui_select") then
     return opts
@@ -31,28 +75,7 @@ local function apidocs_open(opts)
   local docs_path = common.data_folder()
   local fs = vim.uv.fs_scandir(docs_path)
   local candidates = {}
-  local installed_docs = {}
-  while true do
-    local name, type = vim.uv.fs_scandir_next(fs)
-    if not name then
-      break
-    end
-    if type == "directory" then
-      if opts and opts.restrict_sources then
-        for _, source in ipairs(opts.restrict_sources) do
-          if vim.tbl_contains(opts.restrict_sources, name) then
-            table.insert(installed_docs, name)
-          -- no exact match, check for partial match
-          -- e.g. "python" -> "python~3.12"
-          elseif name:match("^" .. source .. "~%d+(%.%d+)?$") then
-            table.insert(installed_docs, name)
-          end
-        end
-      else
-        table.insert(installed_docs, name)
-      end
-    end
-  end
+  local installed_docs = get_installed_docs(fs, opts)
 
   if opts and opts.ensure_installed then
     for _, source in ipairs(opts.ensure_installed) do
@@ -135,6 +158,7 @@ end
 
 local function setup(conf)
   set_config(conf)
+  ensure_installed(conf)
   vim.api.nvim_create_user_command("ApidocsInstall", install.apidocs_install, {})
   vim.api.nvim_create_user_command("ApidocsOpen", apidocs_open, {})
   vim.api.nvim_create_user_command("ApidocsSearch", apidocs_search, {})

lua/apidocs/telescope.lua

@@ -105,6 +105,7 @@ local function apidocs_search(opts)
   end
   local search_dirs = get_data_dirs(opts)
 
+
   local default_entry_maker = make_entry.gen_from_vimgrep()
   local function entry_maker(entry)
     local r = default_entry_maker(entry)