refactor: cleanup

* refactor: code cleanup

Simplified pickers, some functions and made some cleanup.

* update: additional changes

Reordered symbols in `transpiler.lua`.

* refactor: make paths global

* refactor: remplace all paths

Use the global paths to construct all paths.

Author: luckasRanarison

lua/nvim-devdocs/build.lua

@@ -1,23 +1,16 @@
-local path = require("plenary.path")
-
 local notify = require("nvim-devdocs.notify")
-local plugin_config = require("nvim-devdocs.config").get()
-local html_to_md = require("nvim-devdocs.transpiler").html_to_md
+local transpiler = require("nvim-devdocs.transpiler")
 
 local function build_docs(entry, index, docs)
   local alias = entry.slug:gsub("~", "-")
+  local current_doc_dir = DOCS_DIR:joinpath(alias)
 
   notify.log("Building " .. alias .. " documentation...")
 
-  local docs_dir = path:new(plugin_config.dir_path, "docs")
-  local current_doc_dir = path:new(docs_dir, alias)
-  local index_path = path:new(plugin_config.dir_path, "index.json")
-  local lock_path = path:new(plugin_config.dir_path, "docs-lock.json")
-
-  if not docs_dir:exists() then docs_dir:mkdir() end
+  if not DOCS_DIR:exists() then DOCS_DIR:mkdir() end
+  if not INDEX_PATH:exists() then INDEX_PATH:write("{}", "w") end
+  if not LOCK_PATH:exists() then LOCK_PATH:write("{}", "w") end
   if not current_doc_dir:exists() then current_doc_dir:mkdir() end
-  if not index_path:exists() then index_path:write("{}", "w") end
-  if not lock_path:exists() then lock_path:write("{}", "w") end
 
   local section_map = {}
   local path_map = {}
@@ -35,17 +28,14 @@ local function build_docs(entry, index, docs)
 
   for key, doc in pairs(docs) do
     local sections = section_map[key]
-
-    local markdown, md_sections = html_to_md(doc, sections)
+    local markdown, md_sections = transpiler.html_to_md(doc, sections)
+    local file_path = current_doc_dir:joinpath(tostring(count) .. ".md")
 
     for id, md_path in pairs(md_sections) do
       path_map[key .. "#" .. id] = count .. "," .. md_path
     end
 
     path_map[key] = tostring(count)
-
-    local file_path = path:new(current_doc_dir, tostring(count) .. ".md")
-
     file_path:write(markdown, "w")
     count = count + 1
   end
@@ -56,13 +46,13 @@ local function build_docs(entry, index, docs)
     index.entries[i].path = path_map[index_entry.path] or path_map[main]
   end
 
-  local index_parsed = vim.fn.json_decode(index_path:read())
+  local index_parsed = vim.fn.json_decode(INDEX_PATH:read())
   index_parsed[alias] = index
-  index_path:write(vim.fn.json_encode(index_parsed), "w")
+  INDEX_PATH:write(vim.fn.json_encode(index_parsed), "w")
 
-  local lock_parsed = vim.fn.json_decode(lock_path:read())
+  local lock_parsed = vim.fn.json_decode(LOCK_PATH:read())
   lock_parsed[alias] = entry
-  lock_path:write(vim.fn.json_encode(lock_parsed), "w")
+  LOCK_PATH:write(vim.fn.json_encode(lock_parsed), "w")
 
   notify.log("Build complete!")
 end

lua/nvim-devdocs/completion.lua

@@ -1,16 +1,11 @@
 local M = {}
 
-local path = require("plenary.path")
-
 local list = require("nvim-devdocs.list")
-local plugin_config = require("nvim-devdocs.config").get()
 
 M.get_non_installed = function(arg_lead)
-  local registery_path = path:new(plugin_config.dir_path, "registery.json")
-
-  if not registery_path:exists() then return {} end
+  if not REGISTERY_PATH:exists() then return {} end
 
-  local content = registery_path:read()
+  local content = REGISTERY_PATH:read()
   local parsed = vim.fn.json_decode(content)
   local installed = list.get_installed_alias()
   local args = {}

lua/nvim-devdocs/config.lua

@@ -1,5 +1,7 @@
 local M = {}
 
+local path = require("plenary.path")
+
 local config = {
   dir_path = vim.fn.stdpath("data") .. "/devdocs",
   telescope = {},
@@ -19,7 +21,8 @@ local config = {
   mappings = {
     open_in_browser = "",
   },
-  after_open = function() end,
+  ---@diagnostic disable-next-line: unused-local
+  after_open = function(bufnr) end,
 }
 
 M.get = function() return config end
@@ -31,7 +34,29 @@ M.setup = function(new_config)
     end
   end
 
+  DATA_DIR = path:new(config.dir_path)
+  DOCS_DIR = DATA_DIR:joinpath("docs")
+  INDEX_PATH = DATA_DIR:joinpath("index.json")
+  LOCK_PATH = DATA_DIR:joinpath("docs-lock.json")
+  REGISTERY_PATH = DATA_DIR:joinpath("registery.json")
+
   return config
 end
 
+M.set_keymaps = function(bufnr, entry)
+  local slug = entry.alias:gsub("-", "~")
+  local keymaps = config.mappings
+  local set_buf_keymap = function(key, action, description)
+    vim.keymap.set("n", key, action, { buffer = bufnr, desc = description })
+  end
+
+  if type(keymaps.open_in_browser) == "string" and keymaps.open_in_browser ~= "" then
+    set_buf_keymap(
+      keymaps.open_in_browser,
+      function() vim.ui.open("https://devdocs.io/" .. slug .. "/" .. entry.link) end,
+      "Open in the browser"
+    )
+  end
+end
+
 return M

lua/nvim-devdocs/init.lua

@@ -26,28 +26,22 @@ M.uninstall_doc = function(args)
   end
 end
 
-M.open_doc = function(args)
+M.open_doc = function(args, float)
   if vim.tbl_isempty(args.fargs) then
-    pickers.global_search_picker(false)
+    local entries = operations.get_all_entries()
+    pickers.open_picker(entries, float)
   else
     local alias = args.fargs[1]
-    pickers.open_picker(alias, false)
+    pickers.open_picker_alias(alias, float)
   end
 end
 
-M.open_doc_float = function(args)
-  if vim.tbl_isempty(args.fargs) then
-    pickers.global_search_picker(true)
-  else
-    local alias = args.fargs[1]
-    pickers.open_picker(alias, true)
-  end
-end
+M.open_doc_float = function(args) M.open_doc(args, true) end
 
 M.open_doc_current_file = function(float)
   local filetype = vim.bo.filetype
   local alias = filetypes[filetype] or filetype
-  pickers.open_picker(alias, float)
+  pickers.open_picker_alias(alias, float)
 end
 
 M.update = function(args)

lua/nvim-devdocs/list.lua

@@ -1,30 +1,24 @@
 local M = {}
 
-local path = require("plenary.path")
-
 local notify = require("nvim-devdocs.notify")
-local plugin_config = require("nvim-devdocs.config").get()
-
-local lock_path = path:new(plugin_config.dir_path, "docs-lock.json")
-local registery_path = path:new(plugin_config.dir_path, "registery.json")
 
 M.get_installed_alias = function()
-  if not lock_path:exists() then return {} end
+  if not LOCK_PATH:exists() then return {} end
 
-  local lockfile = lock_path:read()
+  local lockfile = LOCK_PATH:read()
   local lock_parsed = vim.fn.json_decode(lockfile)
   local installed = vim.tbl_keys(lock_parsed)
 
   return installed
 end
 
 M.get_installed_entry = function()
-  if not registery_path:exists() then
+  if not REGISTERY_PATH:exists() then
     notify.log_err("Devdocs registery not found, please run :DevdocsFetch")
     return
   end
 
-  local content = registery_path:read()
+  local content = REGISTERY_PATH:read()
   local parsed = vim.fn.json_decode(content)
   local installed = M.get_installed_alias()
 
@@ -39,12 +33,12 @@ M.get_installed_entry = function()
 end
 
 M.get_updatable = function()
-  if not registery_path:exists() or not lock_path:exists() then return {} end
+  if not REGISTERY_PATH:exists() or not LOCK_PATH:exists() then return {} end
 
   local results = {}
-  local registery = registery_path:read()
+  local registery = REGISTERY_PATH:read()
   local registery_parsed = vim.fn.json_decode(registery)
-  local lockfile = lock_path:read()
+  local lockfile = LOCK_PATH:read()
   local lock_parsed = vim.fn.json_decode(lockfile)
 
   for alias, value in pairs(lock_parsed) do

lua/nvim-devdocs/operations.lua

@@ -2,36 +2,28 @@ local M = {}
 
 local job = require("plenary.job")
 local curl = require("plenary.curl")
-local path = require("plenary.path")
-local state = require("nvim-devdocs.state")
 
 local list = require("nvim-devdocs.list")
+local state = require("nvim-devdocs.state")
 local notify = require("nvim-devdocs.notify")
-local plugin_config = require("nvim-devdocs.config").get()
+local config = require("nvim-devdocs.config")
 local build_docs = require("nvim-devdocs.build")
 
 local devdocs_site_url = "https://devdocs.io"
 local devdocs_cdn_url = "https://documents.devdocs.io"
-local docs_dir = path:new(plugin_config.dir_path, "docs")
-local lock_path = path:new(plugin_config.dir_path, "docs-lock.json")
-local registery_path = path:new(plugin_config.dir_path, "registery.json")
-local index_path = path:new(plugin_config.dir_path, "index.json")
+
+local plugin_config = config.get()
 
 M.fetch = function()
   notify.log("Fetching DevDocs registery...")
 
   curl.get(devdocs_site_url .. "/docs.json", {
     headers = {
-      ["User-agent"] = "chrome",
+      ["User-agent"] = "chrome", -- fake user agent, see #25
     },
     callback = function(response)
-      local dir_path = path:new(plugin_config.dir_path)
-      local file_path = path:new(plugin_config.dir_path, "registery.json")
-
-      if not dir_path:exists() then dir_path:mkdir() end
-
-      file_path:write(response.body, "w", 438)
-
+      if not DATA_DIR:exists() then DATA_DIR:mkdir() end
+      REGISTERY_PATH:write(response.body, "w", 438)
       notify.log("DevDocs registery has been written to the disk")
     end,
     on_error = function(error)
@@ -41,7 +33,7 @@ M.fetch = function()
 end
 
 M.install = function(entry, verbose, is_update)
-  if not registery_path:exists() then
+  if not REGISTERY_PATH:exists() then
     if verbose then notify.log_err("DevDocs registery not found, please run :DevdocsFetch") end
     return
   end
@@ -98,13 +90,13 @@ M.install = function(entry, verbose, is_update)
 end
 
 M.install_args = function(args, verbose, is_update)
-  if not registery_path:exists() then
+  if not REGISTERY_PATH:exists() then
     if verbose then notify.log_err("DevDocs registery not found, please run :DevdocsFetch") end
     return
   end
 
   local updatable = list.get_updatable()
-  local content = registery_path:read()
+  local content = REGISTERY_PATH:read()
   local parsed = vim.fn.json_decode(content)
 
   for _, arg in ipairs(args) do
@@ -136,15 +128,15 @@ M.uninstall = function(alias)
   if not vim.tbl_contains(installed, alias) then
     notify.log(alias .. " documentation is already uninstalled")
   else
-    local index = vim.fn.json_decode(index_path:read())
-    local lockfile = vim.fn.json_decode(lock_path:read())
-    local doc_path = path:new(docs_dir, alias)
+    local index = vim.fn.json_decode(INDEX_PATH:read())
+    local lockfile = vim.fn.json_decode(LOCK_PATH:read())
+    local doc_path = DOCS_DIR:joinpath(alias)
 
     index[alias] = nil
     lockfile[alias] = nil
 
-    index_path:write(vim.fn.json_encode(index), "w")
-    lock_path:write(vim.fn.json_encode(lockfile), "w")
+    INDEX_PATH:write(vim.fn.json_encode(index), "w")
+    LOCK_PATH:write(vim.fn.json_encode(lockfile), "w")
     doc_path:rm({ recursive = true })
 
     notify.log(alias .. " documentation has been uninstalled")
@@ -155,9 +147,9 @@ M.get_entries = function(alias)
   local installed = list.get_installed_alias()
   local is_installed = vim.tbl_contains(installed, alias)
 
-  if not index_path:exists() or not is_installed then return end
+  if not INDEX_PATH:exists() or not is_installed then return end
 
-  local index_parsed = vim.fn.json_decode(index_path:read())
+  local index_parsed = vim.fn.json_decode(INDEX_PATH:read())
   local entries = index_parsed[alias].entries
 
   for key, _ in ipairs(entries) do
@@ -168,10 +160,10 @@ M.get_entries = function(alias)
 end
 
 M.get_all_entries = function()
-  if not index_path:exists() then return {} end
+  if not INDEX_PATH:exists() then return {} end
 
   local entries = {}
-  local index_parsed = vim.fn.json_decode(index_path:read())
+  local index_parsed = vim.fn.json_decode(INDEX_PATH:read())
 
   for alias, index in pairs(index_parsed) do
     for _, doc_entry in ipairs(index.entries) do
@@ -215,7 +207,7 @@ M.filter_doc = function(lines, pattern)
 end
 
 M.render_cmd = function(bufnr, is_picker)
-  vim.bo[bufnr].ft = "glow"
+  vim.bo[bufnr].ft = plugin_config.previewer_cmd
 
   local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
   local chan = vim.api.nvim_open_term(bufnr, {})
@@ -247,8 +239,8 @@ M.open = function(entry, bufnr, float)
     local col = (ui.width - plugin_config.float_win.width) * 0.5
     local float_opts = plugin_config.float_win
 
-    if not plugin_config.row then float_opts.row = row end
-    if not plugin_config.col then float_opts.col = col end
+    float_opts.row = plugin_config.row or row
+    float_opts.col = plugin_config.col or col
 
     local win = nil
     local last_win = state.get("last_win")
@@ -275,20 +267,7 @@ M.open = function(entry, bufnr, float)
     vim.bo[bufnr].ft = "markdown"
   end
 
-  local slug = entry.alias:gsub("-", "~")
-  local keymaps = plugin_config.mappings
-  local set_buf_keymap = function(key, action, description)
-    vim.keymap.set("n", key, action, { buffer = bufnr, desc = description })
-  end
-
-  if type(keymaps.open_in_browser) == "string" and keymaps.open_in_browser ~= "" then
-    set_buf_keymap(
-      keymaps.open_in_browser,
-      function() vim.ui.open("https://devdocs.io/" .. slug .. "/" .. entry.link) end,
-      "Open in the browser"
-    )
-  end
-
+  config.set_keymaps(bufnr, entry)
   plugin_config.after_open(bufnr)
 end