feat: allow remote use of quickfix mode (nvim -q)

fixes #94

Author: willothy

lua/flatten/core.lua

@@ -136,6 +136,7 @@ function M.edit_files(opts)
   local focus_first = config.window.focus == "first"
   local open = config.window.open
   local data = opts.data
+  local quickfix = opts.quickfix
 
   local nfiles = #files
   local stdin_lines = #stdin
@@ -148,6 +149,7 @@ function M.edit_files(opts)
     and stdin_lines == 0
     and #pre_cmds == 0
     and #post_cmds == 0
+    and #quickfix == 0
   then
     -- If there are no new bufs and no commands, don't open anything
     -- and tell the guest not to block
@@ -201,6 +203,10 @@ function M.edit_files(opts)
     }
   end
 
+  if quickfix then
+    vim.fn.setqflist(quickfix, "r")
+  end
+
   ---@type Flatten.WindowId
   local winnr
   ---@type Flatten.BufferId

lua/flatten/guest.lua

@@ -37,8 +37,8 @@ function M.maybe_block(block)
   end
 end
 
-function M.send_files(files, stdin)
-  if #files < 1 and #stdin < 1 then
+function M.send_files(files, stdin, quickfix)
+  if #files < 1 and #stdin < 1 and #quickfix < 1 then
     return
   end
 
@@ -57,6 +57,7 @@ function M.send_files(files, stdin)
     response_pipe = server,
     guest_cwd = cwd,
     stdin = stdin,
+    quickfix = quickfix,
     argv = vim.v.argv,
     force_block = force_block,
   }
@@ -146,9 +147,13 @@ function M.init(host_pipe)
         :totable()
       nfiles = #files
 
+      local quickfix = vim.iter(vim.api.nvim_list_bufs()):find(function(buf)
+        return vim.bo[buf].filetype == "quickfix"
+      end)
+
       -- No arguments, user is probably opening a nested session intentionally
       -- Or only piping input from stdin
-      if nfiles < 1 then
+      if nfiles < 1 and not quickfix then
         local should_nest, should_block = config.nest_if_no_args, false
 
         if config.callbacks.no_files then
@@ -176,7 +181,28 @@ function M.init(host_pipe)
         M.maybe_block(should_block)
       end
 
-      M.send_files(files, {})
+      quickfix = vim
+        .iter(vim.fn.getqflist())
+        :map(function(old)
+          return {
+            filename = vim.api.nvim_buf_get_name(old.bufnr),
+            module = old.module,
+            lnum = old.lnum,
+            end_lnum = old.end_lnum,
+            col = old.col,
+            end_col = old.end_col,
+            vcol = old.vcol,
+            nr = old.nr,
+            text = old.text,
+            pattern = old.pattern,
+            type = old.type,
+            valid = old.valid,
+            user_data = old.user_data,
+          }
+        end)
+        :totable()
+
+      M.send_files(files, {}, quickfix)
     end,
   })
 end

lua/flatten/init.lua

@@ -21,13 +21,14 @@ local Flatten = {}
 ---@field nest_if_no_args Flatten.NestIfNoArgs?
 
 ---@class Flatten.EditFilesOptions
----@field files table          list of files passed into nested instance
----@field response_pipe string guest default socket
----@field guest_cwd string     guest global cwd
----@field argv table           full list of options passed to the nested instance, see v:argv
----@field stdin table          stdin lines or {}
----@field force_block boolean  enable blocking
----@field data any?            arbitrary data passed to the host
+---@field files table                     list of files passed into nested instance
+---@field response_pipe string            guest default socket
+---@field guest_cwd string                guest global cwd
+---@field argv string[]                   full list of options passed to the nested instance, see v:argv
+---@field stdin string[]                  stdin lines or {}
+---@field quickfix vim.quickfix.entry[]   quickfix list or {}
+---@field force_block boolean             enable blocking
+---@field data any?                       arbitrary data passed to the host
 
 ---Specify blocking by filetype
 ---@alias Flatten.BlockFor table<string, boolean>