fix: preview splitting (#59)

* improved splitting: sort entries

fixes #57

* improved splitting: review comments

Author: emmanueltouzery

lua/nvim-devdocs/build.lua

@@ -7,6 +7,8 @@ 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)
+  local sort_lookup = {}
+  local sort_lookup_last_index = 1
 
   notify.log("Building " .. alias .. " documentation...")
 
@@ -34,15 +36,22 @@ local function build_docs(entry, index, docs)
     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
+    for _, section in ipairs(md_sections) do
+      path_map[key .. "#" .. section.id] = count .. "," .. section.md_path
+      sort_lookup[key .. "#" .. section.id] = sort_lookup_last_index
+      sort_lookup_last_index = sort_lookup_last_index + 1
     end
 
     path_map[key] = tostring(count)
     file_path:write(markdown, "w")
     count = count + 1
   end
 
+  table.sort(index.entries, function(a, b)
+    local index_a = sort_lookup[a.path] or -1
+    local index_b = sort_lookup[b.path] or -1
+    return index_a < index_b
+  end)
   for i, index_entry in ipairs(index.entries) do
     local main = vim.split(index_entry.path, "#")[1]
     index.entries[i].link = index.entries[i].path

lua/nvim-devdocs/operations.lua

@@ -174,11 +174,17 @@ M.get_all_entries = function()
   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
+    local entries_count = #index.entries
+    for idx, doc_entry in ipairs(index.entries) do
+      local next_path = nil
+      if idx < entries_count then
+        next_path = index.entries[idx+1].path
+      end
       local entry = {
         name = string.format("[%s] %s", alias, doc_entry.name),
         alias = alias,
         path = doc_entry.path,
+        next_path = next_path,
         link = doc_entry.link,
       }
       table.insert(entries, entry)
@@ -197,8 +203,12 @@ M.read_entry = function(entry, callback)
 
   file_path:_read_async(vim.schedule_wrap(function(content)
     local pattern = splited_path[2]
+    local next_pattern = nil
+    if entry.next_path ~= nil then
+      next_pattern = vim.split(entry.next_path, ",")[2]
+    end
     local lines = vim.split(content, "\n")
-    local filtered_lines = M.filter_doc(lines, pattern)
+    local filtered_lines = M.filter_doc(lines, pattern, next_pattern)
 
     callback(filtered_lines)
   end))
@@ -207,8 +217,9 @@ end
 ---if we have a pattern to search for, only consider lines after the pattern
 ---@param lines string[]
 ---@param pattern? string
+---@param next_pattern? string
 ---@return string[]
-M.filter_doc = function(lines, pattern)
+M.filter_doc = function(lines, pattern, next_pattern)
   if not pattern then return lines end
 
   -- https://stackoverflow.com/a/34953646/516188
@@ -218,15 +229,15 @@ M.filter_doc = function(lines, pattern)
   local found = false
   local pattern_lines = vim.split(pattern, "\n")
   local search_pattern = create_pattern(pattern_lines[1]) -- only search the first line
-  local split = vim.split(pattern, " ")
-  local header = split[1]
-  local top_header = header and header:sub(1, #header - 1)
+  local next_search_pattern = nil
+  if next_pattern then
+    local next_pattern_lines = vim.split(next_pattern, "\n")
+    next_search_pattern = create_pattern(next_pattern_lines[1]) -- only search the first line
+  end
 
   for _, line in ipairs(lines) do
-    if found then
-      local line_split = vim.split(line, " ")
-      local first = line_split[1]
-      if first == header or first == top_header then break end
+    if found and next_search_pattern then
+      if line:match(next_search_pattern) then break end
     end
     if line:match(search_pattern) then found = true end
     if found then table.insert(filtered_lines, line) end

lua/nvim-devdocs/transpiler.lua

@@ -323,7 +323,7 @@ function transpiler:eval(node)
   local id = attributes.id
 
   if id and self.section_map and vim.tbl_contains(self.section_map, id) then
-    self.sections[id] = vim.trim(result)
+    table.insert(self.sections, {id = id, md_path = vim.trim(result)})
   end
 
   return result