feat: Add 'display_counter' toggle - closes #32

Author: Andrew Ferrier

README.md

@@ -178,6 +178,7 @@ end)
 | ------------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
 | `create_keymaps`    | `true`       | Creates default keymappings - see above                                                                                                      |
 | `move_to_debugline` | `false`      | When adding a debug line, moves the cursor to that line                                                                                      |
+| `display_counter`   | `true`       | Whether to display/include the monotonically increasing counter in each debug message added                                                  |
 | `filetypes`         | See below    | Custom filetypes - see below                                                                                                                 |
 | `ignore_treesitter` | `false`      | Never use treesitter to find a variable under the cursor, always prompt for it - overrides the same setting on `debugprint()` if set to true |
 | `print_tag`         | `DEBUGPRINT` | The string inserted into each print statement, which can be used to uniquely identify statements inserted by `debugprint`.                   |

lua/debugprint/init.lua

@@ -7,6 +7,7 @@ local global_opts
 GLOBAL_OPTION_DEFAULTS = {
     create_keymaps = true,
     create_commands = true,
+    display_counter = true,
     move_to_debugline = false,
     ignore_treesitter = false,
     filetypes = require("debugprint.filetypes"),
@@ -26,9 +27,14 @@ local debuginfo = function(variable_name)
     counter = counter + 1
 
     local line = global_opts.print_tag
-        .. "["
+
+    if global_opts.display_counter then
+        line = line .. "["
         .. counter
-        .. "]: "
+        .. "]"
+    end
+
+    line = line .. ": "
         .. vim.fn.expand("%:t")
         .. ":"
         .. current_line
@@ -241,6 +247,7 @@ M.setup = function(opts)
     vim.validate({
         create_keymaps = { global_opts.create_keymaps, "boolean" },
         create_commands = { global_opts.create_commands, "boolean" },
+        display_counter = { global_opts.move_to_debugline, "boolean" },
         move_to_debugline = { global_opts.move_to_debugline, "boolean" },
         ignore_treesitter = { global_opts.ignore_treesitter, "boolean" },
         filetypes = { global_opts.filetypes, "table" },

tests/debugprint.lua

@@ -1036,3 +1036,41 @@ describe("delete lines command", function()
         })
     end)
 end)
+
+describe("don't display counter", function()
+    before_each(function()
+        debugprint.setup({ ignore_treesitter = true, display_counter = false })
+    end)
+
+    it("basic statement", function()
+        local filename = init_file({
+            "foo",
+            "bar",
+        }, "lua", 1, 0)
+
+        feedkeys("g?p")
+
+        check_lines({
+            "foo",
+            "print('DEBUGPRINT: " .. filename .. ":1')",
+            "bar",
+        })
+    end)
+
+    it("can insert a variable statement below", function()
+        local filename = init_file({
+            "foo",
+            "bar",
+        }, "lua", 1, 0)
+
+        feedkeys("g?vbanana<CR>")
+
+        check_lines({
+            "foo",
+            "print('DEBUGPRINT: "
+                .. filename
+                .. ":1: banana=' .. vim.inspect(banana))",
+            "bar",
+        })
+    end)
+end)