feat!: enable inserting multiple refs at once

- requires breaking change in `cite_formats` option

Author: jghauser

lua/papis/at-cursor/init.lua

@@ -9,11 +9,10 @@ local NuiPopup = require("nui.popup")
 local nuiAutocmd = require("nui.utils.autocmd")
 local nuiEvent = require("nui.utils.autocmd").event
 
-local fn = vim.fn
-
 local log = require("papis.log")
 local config = require("papis.config")
 local popup_format = config["at-cursor"].popup_format
+local cite_format = config:get_cite_format()
 local utils = require("papis.utils")
 local commands = require("papis.commands")
 local keymaps = require("papis.keymaps")
@@ -25,24 +24,40 @@ end
 ---Tries to identify the ref under cursor
 ---@return string|nil #Nil if nothing is found, otherwise is the identified ref
 local function get_ref_under_cursor()
-  -- get the word under the cursor
-  local ref = fn.expand("<cWORD>")
-  local filetype = vim.bo.filetype
-  log.debug("The filetype is: " .. filetype)
-  local cite_format = utils.get_cite_format(filetype)
-  if type(cite_format) == "table" then
-    cite_format = cite_format[2]
-  end
-  log.debug("The cite_format is: " .. cite_format)
-  local _, prefix_end = string.find(cite_format, "%%s")
-  prefix_end = prefix_end - 2
-  local cite_format_prefix = string.sub(cite_format, 1, prefix_end)
-  local _, ref_start = string.find(ref, cite_format_prefix)
+  local start_str = cite_format.start_str
+  local ref_prefix = cite_format.ref_prefix
+
+  -- get current line and cursor position
+  local current_line = vim.api.nvim_get_current_line()
+  local _, cursor_col = unpack(vim.api.nvim_win_get_cursor(0))
+
+  -- Find the start and end of the word under the cursor
+  local line_until_cursor = current_line:sub(1, cursor_col)
+  local word_start_col = line_until_cursor:find("[^%s,;]*$") or 1
+  local line_after_cursor = current_line:sub(cursor_col)
+  local word_end_col = cursor_col + (line_after_cursor:find("[%s,;]") or #line_after_cursor) - 1
+
+  -- Extract the word
+  local ref = current_line:sub(word_start_col, word_end_col)
+
   -- if we found the cite_format prefix in the string, we need to strip it
-  if ref_start then
-    ref_start = ref_start + 1
-    ref = string.sub(ref, ref_start)
+  if start_str then
+    local escaped_start_str = start_str:gsub("%W", "%%%0")
+    local _, ref_start = string.find(ref, escaped_start_str)
+    if ref_start then
+      ref = string.sub(ref, ref_start + 1)
+    end
   end
+  -- if we found the ref_prefix in the string, we need to strip it
+  if ref_prefix then
+    local escaped_ref_prefix = ref_prefix:gsub("%W", "%%%0")
+    local _, ref_start = string.find(ref, escaped_ref_prefix)
+    if ref_start then
+      ref_start = ref_start + 1
+      ref = string.sub(ref, ref_start)
+    end
+  end
+
   -- remove all punctuation characters at the beginning and end of string
   ref = ref:gsub("^[%p]*(.-)[%p]*$", "%1")
 

lua/papis/config.lua

@@ -18,12 +18,33 @@ local default_config = {
     ["testing"] = false,
   }, -- can be set to nil or false or left out
   cite_formats = {
-    tex = { "\\cite{%s}", "\\cite[tp]?%*?{%s}" },
-    markdown = "@%s",
-    rmd = "@%s",
-    plain = "%s",
-    org = { "[cite:@%s]", "%[cite:@%s]" },
-    norg = "{= %s}",
+    tex = {
+      start_str = [[\cite{]],
+      end_str = "}",
+      separator_str = ", ",
+    },
+    markdown = {
+      ref_prefix = "@",
+      separator_str = "; "
+    },
+    rmd = {
+      ref_prefix = "@",
+      separator_str = "; "
+    },
+    plain = {
+      separator_str = ", "
+    },
+    org = {
+      start_str = "[cite:",
+      end_str = "]",
+      ref_prefix = "@",
+      separator_str = ";",
+    },
+    norg = {
+      start_str = "{= ",
+      end_str = "}",
+      separator_str = "; ",
+    },
   },
   cite_formats_fallback = "plain",
   always_use_plain = false,
@@ -145,6 +166,27 @@ local default_config = {
 
 local M = vim.deepcopy(default_config)
 
+---Get the cite_format for the current filetype
+---@return table #cite_format to be used for the filetype. If table, then first is for inserting, second for parsing
+function M:get_cite_format()
+  local filetype = vim.bo.filetype
+
+  local cite_formats = self.cite_formats
+  local cite_formats_fallback = self.cite_formats_fallback
+
+  local fallback = {
+    separator_str = ", "
+  }
+
+  if self.always_use_plain then
+    local cite_format = cite_formats.plain or fallback
+    return cite_format
+  else
+    local cite_format = cite_formats[filetype] or cite_formats[cite_formats_fallback]
+    return cite_format
+  end
+end
+
 ---Updates the default configuration with user supplied options and gets conf from Papis
 ---@param opts table #Same format as default_config and contains user config
 function M:update(opts)

lua/papis/utils.lua

@@ -28,23 +28,6 @@ end
 
 local M = {}
 
----Get the cite_format for the current filetype
----@param filetype string #Filetype for which we need a cite_format
----@return string|table #cite_format to be used for the filetype. If table, then first is for inserting, second for parsing
-function M.get_cite_format(filetype)
-  local config = require("papis.config")
-  local cite_formats = config.cite_formats
-  local cite_formats_fallback = config.cite_formats_fallback
-
-  if config.always_use_plain then
-    local cite_format = cite_formats.plain or "%s"
-    return cite_format
-  else
-    local cite_format = cite_formats[filetype] or cite_formats[cite_formats_fallback]
-    return cite_format
-  end
-end
-
 ---Splits string by `inputstr` and trims whitespace
 ---@param inputstr string #String to be split
 ---@param sep? string #String giving each character by which to split

lua/telescope/_extensions/papis.lua

@@ -15,21 +15,12 @@ local telescope_config = require("telescope.config").values
 local papis_actions = require("telescope._extensions.papis.actions")
 
 local utils = require("papis.utils")
+local config = require("papis.config")
 local db = require("papis.sqlite-wrapper")
 if not db then
   return nil
 end
 
----Gets the cite format for the filetype
----@return string #The cite format for the filetype (or fallback if undefined)
-local function parse_format_string()
-  local cite_format = utils.get_cite_format(vim.bo.filetype)
-  if type(cite_format) == "table" then
-    cite_format = cite_format[1]
-  end
-  return cite_format
-end
-
 local wrap, preview_format, initial_sort_by_time_added
 
 ---Defines the papis.nvim telescope picker
@@ -40,9 +31,6 @@ local function papis_picker(opts)
   -- get precalculated entries for the telescope picker
   local telescope_precalc = require("papis.search").get_precalc()
 
-  -- local results = db.data:get(nil, required_db_keys)
-  local format_string = parse_format_string()
-
   -- amend the generic_sorter so that we can change initial sorting
   local generic_sorter = telescope_config.generic_sorter(opts)
   local papis_sorter = {}
@@ -88,7 +76,7 @@ local function papis_picker(opts)
         sorter = papis_sorter,
         attach_mappings = function(prompt_bufnr, map)
           actions.select_default:replace(
-            function() papis_actions.ref_insert(prompt_bufnr, format_string) end)
+            function() papis_actions.ref_insert(prompt_bufnr) end)
           map("i", "<c-o>f",
             function() papis_actions.open_file(prompt_bufnr) end,
             { desc = "Open file" })

lua/telescope/_extensions/papis/actions.lua

@@ -21,21 +21,27 @@ local M = {}
 
 ---This function inserts a formatted ref string at the cursor
 ---@param prompt_bufnr number @The buffer number of the prompt
----@param format_string string @The string to be inserted
-M.ref_insert = function(prompt_bufnr, format_string)
+M.ref_insert = function(prompt_bufnr)
   local multi = get_multi(prompt_bufnr)
-
   actions.close(prompt_bufnr)
-  local string_to_insert = ""
+  local cite_format = config:get_cite_format()
+  local start_str = cite_format.start_str
+  local end_str = cite_format.end_str
+  local ref_prefix = cite_format.ref_prefix or ""
+  local separator_str = cite_format.separator_str
+  local string_to_insert = start_str or ""
+
   if vim.tbl_isempty(multi) then
-    local ref = string.format(format_string, action_state.get_selected_entry().id.ref)
-    string_to_insert = ref
+    local ref = ref_prefix .. action_state.get_selected_entry().id.ref
+    string_to_insert = string_to_insert .. ref
   else
+    local refs = {}
     for _, entry in pairs(multi) do
-      local ref = string.format(format_string, entry.id.ref)
-      string_to_insert = string_to_insert .. ref .. " "
+      refs[#refs + 1] = ref_prefix .. entry.id.ref
     end
+    string_to_insert = string_to_insert .. table.concat(refs, separator_str)
   end
+  string_to_insert = string_to_insert .. (end_str or "")
   vim.api.nvim_put({ string_to_insert }, "", false, true)
 end