merge: sections only display after section start (#42)

* sections: only display after section start

fixes #28
It was wrong to give all the contents to the preview/display command and
then search on the output, because the command could change the format
completely.
So now we submit to the converter program only data after the section
start, and we don't need to search the output anymore.

* update: simplified & omit the next sections

Simplified the implementation and implemented the next section drop

* wip: filtering in telescope

* wip: previewer with only buf_previewer

* fix: picker cmd args

---------

Co-authored-by: Luckas <[email protected]>

Author: emmanueltouzery

lua/nvim-devdocs/operations.lua

@@ -187,7 +187,55 @@ M.get_all_entries = function()
   return entries
 end
 
-M.open = function(entry, bufnr, pattern, float)
+M.filter_doc = function(lines, pattern)
+  if not pattern then return lines end
+
+  -- https://stackoverflow.com/a/34953646/516188
+  local function create_pattern(text) return text:gsub("([^%w])", "%%%1") end
+
+  local filtered_lines = {}
+  local found = false
+  local search_pattern = create_pattern(pattern)
+  local split = vim.split(pattern, " ")
+  local header = split[1]
+  local top_header = header and header:sub(1, #header - 1)
+
+  for _, line in ipairs(lines) do
+    if found and header then
+      local line_split = vim.split(line, " ")
+      local first = line_split[1]
+      if first and first == header or first == top_header then break end
+    end
+    if line:match(search_pattern) then found = true end
+    if found then table.insert(filtered_lines, line) end
+  end
+
+  return filtered_lines
+end
+
+M.render_cmd = function(bufnr, is_picker)
+  vim.bo[bufnr].ft = "glow"
+
+  local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
+  local chan = vim.api.nvim_open_term(bufnr, {})
+  local args = is_picker and plugin_config.picker_cmd_args or plugin_config.cmd_args
+  local previewer = job:new({
+    command = plugin_config.previewer_cmd,
+    args = args,
+    on_stdout = vim.schedule_wrap(function(_, data)
+      if not data then return end
+      local output_lines = vim.split(data, "\n", {})
+      for _, line in ipairs(output_lines) do
+        pcall(function() vim.api.nvim_chan_send(chan, line .. "\r\n") end)
+      end
+    end),
+    writer = table.concat(lines, "\n"),
+  })
+
+  previewer:start()
+end
+
+M.open = function(entry, bufnr, float)
   vim.api.nvim_buf_set_option(bufnr, "modifiable", false)
 
   if not float then
@@ -209,32 +257,10 @@ M.open = function(entry, bufnr, pattern, float)
     vim.wo[win].relativenumber = false
   end
 
-  vim.fn.search(pattern)
-
   local ignore = vim.tbl_contains(plugin_config.cmd_ignore, entry.alias)
+
   if plugin_config.previewer_cmd and not ignore then
-    vim.bo[bufnr].ft = "glow"
-
-    local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
-    local chan = vim.api.nvim_open_term(bufnr, {})
-    local previewer = job:new({
-      command = plugin_config.previewer_cmd,
-      args = plugin_config.cmd_args,
-      on_stdout = vim.schedule_wrap(function(_, data)
-        local output_lines = vim.split(data, "\n", {})
-        for _, line in ipairs(output_lines) do
-          vim.api.nvim_chan_send(chan, line .. "\r\n")
-        end
-      end),
-      on_exit = vim.schedule_wrap(function()
-        if pattern then
-          local formatted_pattern = pattern:gsub("`", "")
-          vim.defer_fn(function() vim.fn.search(formatted_pattern) end, 500)
-        end
-      end),
-      writer = table.concat(lines, "\n"),
-    })
-    previewer:start()
+    M.render_cmd(bufnr)
   else
     vim.bo[bufnr].ft = "markdown"
   end

lua/nvim-devdocs/pickers.lua

@@ -46,44 +46,28 @@ local metadata_previewer = previewers.new_buffer_previewer({
   end,
 })
 
-local buf_doc_previewer = previewers.new_buffer_previewer({
+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 = path:new(plugin_config.dir_path, "docs", entry.value.alias, file .. ".md")
     local bufnr = self.state.bufnr
-
-    local display_lines = function(lines)
-      vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
-      vim.bo[bufnr].ft = "markdown"
-      -- TODO: highlight in picker
-      -- vim.api.nvim_buf_call(bufnr, function()
-      --   vim.fn.search(section)
-      --   vim.fn.matchadd("Search", pattern)
-      -- end)
-    end
+    local pattern = splited_path[2]
 
     file_path:_read_async(vim.schedule_wrap(function(content)
       local lines = vim.split(content, "\n")
-      display_lines(lines)
-    end))
-  end,
-})
-
-local term_doc_previewer = previewers.new_termopen_previewer({
-  title = "Preview",
-  get_command = function(entry)
-    local splited_path = vim.split(entry.value.path, ",")
-    local file = splited_path[1]
-    local file_path = path:new(plugin_config.dir_path, "docs", entry.value.alias, file .. ".md")
-    local args = { plugin_config.previewer_cmd }
+      local filtered_lines = operations.filter_doc(lines, pattern)
 
-    vim.list_extend(args, plugin_config.picker_cmd_args)
-    table.insert(args, path.__tostring(file_path))
+      vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, filtered_lines)
 
-    return args
+      if plugin_config.picker_cmd then
+        operations.render_cmd(bufnr, true)
+      else
+        vim.bo[bufnr].ft = "markdown"
+      end
+    end))
   end,
 })
 
@@ -96,15 +80,14 @@ local open_doc = function(float)
     local splited_path = vim.split(selection.value.path, ",")
     local file = splited_path[1]
     local file_path = path:new(plugin_config.dir_path, "docs", selection.value.alias, file .. ".md")
-    local content = file_path:read()
-    vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, vim.split(content, "\n"))
+    local lines = file_path:readlines()
+    local filtered_lines = operations.filter_doc(lines, splited_path[2])
+    vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, filtered_lines)
   else
     bufnr = state.get_global_key("last_preview_bufnr")
   end
 
-  local splited_path = vim.split(selection.value.path, ",")
-
-  operations.open(selection.value, bufnr, splited_path[2], float)
+  operations.open(selection.value, bufnr, float)
 end
 
 M.installation_picker = function()
@@ -175,12 +158,6 @@ M.open_picker = function(alias, float)
     return
   end
 
-  local previewer = buf_doc_previewer
-
-  if plugin_config.previewer_cmd and plugin_config.picker_cmd then
-    previewer = term_doc_previewer
-  end
-
   local picker = pickers.new(plugin_config.telescope, {
     prompt_title = "Select an entry",
     finder = finders.new_table({
@@ -194,7 +171,7 @@ M.open_picker = function(alias, float)
       end,
     }),
     sorter = config.generic_sorter(plugin_config.telescope),
-    previewer = previewer,
+    previewer = doc_previewer,
     attach_mappings = function()
       actions.select_default:replace(function(prompt_bufnr)
         actions.close(prompt_bufnr)
@@ -209,12 +186,6 @@ end
 
 M.global_search_picker = function(float)
   local entries = operations.get_all_entries()
-  local previewer = buf_doc_previewer
-
-  if plugin_config.previewer_cmd and plugin_config.picker_cmd then
-    previewer = term_doc_previewer
-  end
-
   local picker = pickers.new(plugin_config.telescope, {
     prompt_title = "Select an entry",
     finder = finders.new_table({
@@ -228,7 +199,7 @@ M.global_search_picker = function(float)
       end,
     }),
     sorter = config.generic_sorter(plugin_config.telescope),
-    previewer = previewer,
+    previewer = doc_previewer,
     attach_mappings = function()
       actions.select_default:replace(function(prompt_bufnr)
         actions.close(prompt_bufnr)