feat: Support DebugPrintQFList

Author: andrewferrier

README.md

@@ -54,8 +54,9 @@ the NeoVim generation. It:
   lines.
 
 - Provides [commands](#keymappings-and-commands) to delete or comment debugging
-  lines added to the current buffer, and search for those lines in the current directory
-  (project) using fzf-lua or telescope.
+  lines added to the current buffer, search for those lines in the current directory
+  (project) using fzf-lua or telescope, and add those lines to the quickfix
+  list.
 
 - Can optionally move to the inserted line (or not).
 
@@ -131,6 +132,7 @@ following table.
 | Command    | `:ToggleCommentDebugPrints` | Comment/uncomment debug lines in buffer                                         | -                          |
 | Command    | `:ResetDebugPrintsCounter`  | Reset debug print persistent counter (only for built-in counter implementation) | -                          |
 | Command    | `:SearchDebugPrints`        | Search for all debug print lines in the current directory using fzf-lua or telescope.nvim | -                |
+| Command    | `:DebugPrintQFList`         | Search for all debug print lines in the current directory and populate quickfix list | -                |
 
 Each of the keymappings (except for 'surround' keys and insert modes) can also
 be prefixed with a register, see the [showcase](SHOWCASE.md#register-usage) for
@@ -256,7 +258,8 @@ they are used to convert sections to ROT-13, which most folks don't use.
 | Comment/uncomment all debug lines in buffer                         | :+1:                           | :+1:                                                  | :x:                                                             | :x:                                                       | :x:                                                                  | :x:                                                 | :x:                                                   |
 | Comment/uncomment all debug lines in selected range                 | :+1:                           | :x:                                                   | :x:                                                             | :x:                                                       | :x:                                                                  | :x:                                                 | :x:                                                   |
 | Can put debugprint text into register                               | :+1:                           | :x:                                                   | :x:                                                             | :+1:                                                      | :x:                                                                  | :x:                                                 | :x:                                                   |
-| Search for debugprint lines in the current directory using fzf-lua  | :+1:                           | :x:                                                   | :x:                                                             | :x:                                                       | :x:                                                                  | :x:                                                 | :x:                                                   |
+| Search for debugprint lines using fzf-lua or telescope              | :+1:                           | :x:                                                   | :x:                                                             | :x:                                                       | :x:                                                                  | :x:                                                 | :x:                                                   |
+| Search for debugprint lines and populate quickfix list              | :+1:                           | :x:                                                   | :x:                                                             | :x:                                                       | :x:                                                                  | :x:                                                 | :x:                                                   |
 | Extra visual emphasis of log statements                             | :+1: Highlights inserted lines | :+1: Flashes to highlight lines on insertion          | :+1: status line counter, signcolumn, line-highlight, scrollbar | :x:                                                       | :x:                                                                  | :x:                                                 | :x:                                                   |
 | Can insert logs in batches                                          | :+1: (using registers)         | :+1:                                                  | :x:                                                             | :x:                                                       | :x:                                                                  | :x:                                                 | :x:                                                   |
 | Log watcher mechanism                                               | :x:                            | :+1:                                                  | :x:                                                             | :x:                                                       | :x:                                                                  | :x:                                                 | :x:                                                   |

lua/debugprint/init.lua

@@ -438,6 +438,16 @@ M.show_debug_prints_fzf = function()
     )
 end
 
+---@return nil
+M.debug_print_qf_list = function()
+    vim.fn.setqflist({}, ' ', {
+        title = 'Debug Prints',
+        lines = vim.fn.systemlist(vim.o.grepprg .. ' "' .. global_opts.print_tag .. '" ' .. vim.fn.getcwd()),
+        efm = '%f:%l:%m'
+    })
+    vim.cmd('copen')
+end
+
 if vim.fn.has("nvim-0.10.0") ~= 1 then
     vim.notify_once(
         "debugprint.nvim is only compatible with NeoVim 0.10+",

lua/debugprint/options.lua

@@ -33,6 +33,7 @@ local GLOBAL_OPTION_DEFAULTS = {
         delete_debug_prints = "DeleteDebugPrints",
         reset_debug_prints_counter = "ResetDebugPrintsCounter",
         search_debug_prints = "SearchDebugPrints",
+        debug_print_qf_list = "DebugPrintQFList",
     },
     display_counter = true,
     display_location = true,

lua/debugprint/setup.lua

@@ -210,6 +210,14 @@ M.map_keys_and_commands = function(global_opts)
             desc = "Search for debug prints using fzf-lua or telescope.nvim",
         }
     )
+
+    create_command(
+        global_opts.commands.debug_print_qf_list,
+        require("debugprint").debug_print_qf_list,
+        {
+            desc = "Search for debug prints and populate quickfix list",
+        }
+    )
 end
 
 return M

lua/debugprint/types.lua

@@ -70,6 +70,7 @@
 ---@field toggle_comment_debug_prints? string|false
 ---@field reset_debug_prints_counter? string|false
 ---@field search_debug_prints? string|false
+---@field debug_print_qf_list? string|false
 
 ---@class debugprint.FunctionOptions
 ---@field above? boolean

tests/debugprint.lua

@@ -48,7 +48,17 @@ end
 local init_file = function(lines, extension, row, col, opts)
     opts = opts or {}
 
-    local tempfile = vim.fn.tempname() .. "." .. extension
+    local tempfile
+
+    if opts.create_in_dir then
+        local dir = vim.fn.tempname()
+        vim.fn.mkdir(dir, "p")
+        tempfile = vim.fs.joinpath(dir, "tmpfile." .. extension)
+        vim.cmd("cd " .. dir)
+    else
+        tempfile = vim.fn.tempname() .. "." .. extension
+    end
+
     vim.cmd("split " .. tempfile)
     vim.cmd("only")
     vim.api.nvim_buf_set_lines(0, 0, -1, false, lines)
@@ -2135,6 +2145,36 @@ describe("comment toggle", function()
     end)
 end)
 
+describe("quickfix list", function()
+    before_each(function()
+        debugprint.setup()
+    end)
+
+    after_each(teardown)
+
+    it("can use DebugPrintQFList command", function()
+        local filename = init_file({
+            "foo",
+            "bar",
+        }, "lua", 1, 0, { create_in_dir = true })
+
+        feedkeys("g?p")
+        vim.cmd("write!")
+
+        check_lines({
+            "foo",
+            "print('DEBUGPRINT[1]: " .. filename .. ":1 (after foo)')",
+            "bar",
+        })
+
+        vim.cmd("DebugPrintQFList")
+
+        local qflist = vim.fn.getqflist()
+        assert.equals(#qflist, 1)
+        assert.True(string.find(qflist[1].text, "DEBUGPRINT") > 0)
+    end)
+end)
+
 describe("handle deprecated options, create_keymaps=false", function()
     before_each(function()
         debugprint.setup({ create_keymaps = false })