feat: open yazi tabs for the files in the quickfix list

Issue
=====

The quickfix list is a versatile tool in neovim, and it can be used for
many different workflows.

yazi.nvim can send files from yazi to the quickfix list, but when this
is done, yazi is closed and the context is lost. When doing project wide
work both in yazi and neovim, it's difficult because of this.

Solution
========

Allow opening yazi tabs for the files in the quickfix list. This only
works if the user has enabled the `open_multiple_tabs` setting.
Otherwise the first quickfix file is selected.

When the quickfix list is open and focused, opening yazi will now open
(probably) 9 of the first files as yazi tabs. The limitation is in place
because yazi can open up to 9 tabs at a time.

Author: mikavilpas

README.md

@@ -222,8 +222,7 @@ return {
     -- }
     open_for_directories = false,
 
-    -- open visible splits as yazi tabs for easy navigation. Requires a yazi
-    -- version more recent than 2024-08-11
+    -- open visible splits and quickfix items as yazi tabs for easy navigation
     -- https://github.com/mikavilpas/yazi.nvim/pull/359
     open_multiple_tabs = false,
 

integration-tests/cypress/e2e/opening-files.cy.ts

@@ -218,6 +218,42 @@ describe("opening files", () => {
     })
   })
 
+  it("can open yazi with the files in the quickfix list", () => {
+    cy.startNeovim({
+      filename: "file2.txt",
+      startupScriptModifications: [
+        "modify_yazi_config_and_open_multiple_files.lua",
+      ],
+    }).then((nvim) => {
+      cy.contains("Hello")
+
+      // add some files to the quickfix list
+      nvim.runLuaCode({
+        luaCode: `vim.fn.setqflist({{filename = "file2.txt"}, {filename = "file3.txt"}})`,
+      })
+
+      // show the quickfix list
+      nvim.runLuaCode({ luaCode: `vim.api.nvim_command('copen')` })
+      cy.contains("file3.txt||")
+
+      // focus the quickfix list
+      nvim.runLuaCode({ luaCode: `vim.api.nvim_command('wincmd j')` })
+
+      // open yazi. It should open two tabs, one for each file in the quickfix
+      // list
+      cy.typeIntoTerminal("{upArrow}")
+      cy.contains("NOR")
+
+      isFileSelectedInYazi("file2.txt" satisfies MyTestDirectoryFile)
+      isFileNotSelectedInYazi("file3.txt" satisfies MyTestDirectoryFile)
+
+      // switch to the next yazi tab. This should select the other file
+      cy.typeIntoTerminal("]")
+      isFileNotSelectedInYazi("file2.txt" satisfies MyTestDirectoryFile)
+      isFileSelectedInYazi("file3.txt" satisfies MyTestDirectoryFile)
+    })
+  })
+
   describe("bulk renaming", () => {
     it("can bulk rename files", () => {
       cy.startNeovim().then(() => {

lua/yazi/utils.lua

@@ -149,9 +149,30 @@ end
 ---@param path string?
 function M.selected_file_paths(path)
   local selected_file_path = M.selected_file_path(path)
+
+  local is_quickfix_window_selected = vim.api.nvim_get_option_value(
+    "buftype",
+    { buf = 0 }
+  ) == "quickfix"
+  if is_quickfix_window_selected then
+    -- get the paths of the files in the quickfix window
+    local qflist = vim.fn.getqflist()
+
+    ---@type Path[]
+    local filenames = {}
+    for _, entry in ipairs(qflist) do
+      if entry.bufnr and entry.bufnr > 0 then
+        local filename = vim.api.nvim_buf_get_name(entry.bufnr)
+        local new_path = plenary_path:new(filename)
+        table.insert(filenames, new_path)
+      end
+    end
+
+    return filenames
+  end
+
   ---@type Path[]
   local paths = { selected_file_path }
-
   for _, buffer in ipairs(M.get_visible_open_buffers()) do
     -- NOTE: yazi can only display up to 9 paths, and it's an error to give any
     -- more