vimtex TOC with another picker

[benkj]

It would be great to use other pickers for the TOC. Currently, vimtex supports various interfaces such as fzf, denite and unite (I use fzf). Many people nowadays use alternative pickers such as fzf-lua, telescope or snacks.picker. Is it possible to support at least some of them or to write some helper functions so that users can easily adapt their setup to use the picker they want?

[lervag]

I think this is a good feature request. I'll look into it when I get the time! I'm more busy these days than I want to be, so no promises on when.

If anyone has the time and want to try, feel free to make a PR. I always prioritize reviewing and accepting contributions!

[benkj]

Thanks. Though this commit is not working for me, run() is instantly closed (the fzf windows is opened for a ms). I fixed this by replacing line 75 with ["--with-nth"] = "2,3", though I still get the #### characters in the table. There are some issues with the delimiter that I can't understand (fzf 0.58,nvim 0.11, latest packages with lazy.nvim)

The example file does not compile, as \subsubsubsection{subsub} is not defined

[lervag]

Thanks. Though this commit is not working for me, run() is instantly closed (the fzf windows is opened for a ms). I fixed this by replacing line 75 with ["--with-nth"] = "2,3", though I still get the #### characters in the table. There are some issues with the delimiter that I can't understand (fzf 0.58,nvim 0.11, latest packages with lazy.nvim)

It worked for me in the example, although not perfectly. I would be happy to get some help to make it work better.

The example file does not compile, as \subsubsubsection{subsub} is not defined

The example is not really meant to compile, it is only meant for testing the TOC (which does not require compilation).

[lervag]

It seems to work with the latest fzf. Can you test if upgrading fzf makes it work for you?

[benkj]

yes, updated to fzf 0.60.3 (debian testing) and it works. The old non-lua one was still visually better (e.g with title and section numbers on two different columns), but this one is ok. I'll try to adapt it if I find some time.
Thanks for your work.

[lervag]

Great, good to hear. The credit is mostly due to @moreka, see #3139. I believe it is somewhat rough around the edges, so I'll be glad to get some follow-up work to make it better.

[moreka]

@lervag @benkj It's true. I just made a minimal working example that was totally based on the vimscript version. I agree that we can make it show in different columns. I'll try to make it better at some point.

[benkj]

ok, a good inspiration is from :FzfLua jumps. One could make something like that with sec/eq numbers in a column, page in another column, and tile in a third. These infos are already available in vimtex TOC, so it is just a matter of reshaping the text. Of course this is my personal taste, so very debatable

[benkj]

I did a small change to the file, here is the diff

-M.run = function(layers)
-  if layers == nil then
-    layers = "ctli"
+M.run = function(options)
+  local layers = "ctli"
+  if options ~= nil and options["layers"] ~= nil then
+    layers = options["layers"]
+    options["layers"] = nil
   end

   local fzf = require "fzf-lua"
@@ -68,11 +72,16 @@ M.run = function(layers)
     )
   end, entries)

+  local fzfoptions = {
+    ["--delimiter"] = "####",
+    ["--with-nth"] = "{2} {3}",
+  }
+  if options ~= nil and options["fzf_opts"] ~= nil then
+    fzfoptions = vim.tbl_extend('force', fzfoptions, options["fzf_opts"])
+  end
+
   fzf.fzf_exec(fzf_entries, {
-    fzf_opts = {
-      ["--delimiter"] = "####",
-      ["--with-nth"] = "{2} {3}",
-    },
+    fzf_opts = fzfoptions,
     actions = {
       default = function(selection, o)
         local s = vim.tbl_map(function(t)

this allows users to change fzf_opts from their config like this

    require("vimtex.fzf-lua").run({
        layers = "ctli", 
        fzf_opts = {
            ["--with-nth"] = "{3}\t{2}",
        }
    })

and add other custom options, e.g. reverse-list. If you think that this feature could be useful I'll try to polish the code/doc and submit a request

[lervag]

I'd be glad to see changes like this proposed in a PR. Notice, though, that it will be good if you also update the docs. There's a short section there that I added.

[moreka]

@benkj Maybe the following has a better visual?

local fzf_entries = vim.tbl_map(function(v)
  return string.format(
    "%s:%d####%5s %s",                -- <- this line has changed
    v.file,
    v.line and v.line or 0,
    format_number(v.number),          -- these two lines are now
    ansi[color_map[v.type]](v.title)  -- swapped
  )
end, entries)

fzf.fzf_exec(fzf_entries, {
  fzf_opts = {
    ["--delimiter"] = "####",
    ["--with-nth"] = "{2}",           -- only need to access the 2nd field
  },
  ...
})

[benkj]

@moreka I'm pretty happy now with your "old" function and ["--with-nth"] = "{3}\t{2}". I guess your new function does something similar, right? In general I think it is good to keep this configurable, so adding another option like I propose above seems easier at this stage, without complicated rewritings.