fix: Remove conflicts with nvim-notify - closes #91

Author: andrewferrier

lua/debugprint/init.lua

@@ -73,30 +73,18 @@ local debuginfo = function(opts)
 end
 
 local filetype_configured = function()
-    local filetype = utils.get_effective_filetype()
+    local effective_filetype = utils.get_effective_filetype()
 
-    if not vim.tbl_contains(vim.tbl_keys(global_opts.filetypes), filetype) then
-        vim.notify(
-            "Don't have debugprint configuration for filetype " .. filetype,
-            vim.log.levels.WARN
-        )
-        return false
-    else
-        return true
-    end
+    return vim.tbl_contains(
+        vim.tbl_keys(global_opts.filetypes),
+        effective_filetype
+    )
 end
 
-local addline = function(opts)
-    local current_line_nr = vim.api.nvim_win_get_cursor(0)[1]
-    local filetype = utils.get_effective_filetype()
-    local fileconfig = global_opts.filetypes[filetype]
+local construct_debugprint_line = function(opts, effective_filetype)
+    local fileconfig = global_opts.filetypes[effective_filetype]
 
-    if fileconfig == nil then
-        return
-    end
-
-    local line_to_insert_content
-    local line_to_insert_linenr
+    local line_to_insert
 
     if opts.variable_name then
         local left
@@ -107,23 +95,52 @@ local addline = function(opts)
             left = fileconfig["left"]
         end
 
-        line_to_insert_content = left
+        line_to_insert = left
             .. debuginfo(opts)
             .. fileconfig.mid_var
             .. opts.variable_name
             .. fileconfig.right_var
     else
         opts.variable_name = nil
-        line_to_insert_content = fileconfig.left
-            .. debuginfo(opts)
-            .. fileconfig.right
+        line_to_insert = fileconfig.left .. debuginfo(opts) .. fileconfig.right
+    end
+
+    return line_to_insert
+end
+
+local construct_error_line = function(errormsg)
+    local commentstring =
+        vim.api.nvim_get_option_value("commentstring", { scope = "local" })
+
+    if string.find(commentstring, "%%s") then
+        return vim.fn.substitute(commentstring, "%s", errormsg, "")
+    else
+        return errormsg
+    end
+end
+
+local addline = function(opts)
+    local effective_filetype = utils.get_effective_filetype()
+
+    local line_to_insert
+
+    if filetype_configured() then
+        line_to_insert = construct_debugprint_line(opts, effective_filetype)
+    else
+        line_to_insert = construct_error_line(
+            "Don't have debugprint configuration for filetype "
+                .. effective_filetype
+                .. "; see https://github.com/andrewferrier/debugprint.nvim?tab=readme-ov-file#add-custom-filetypes"
+        )
     end
 
     -- Inserting the leading space from the current line effectively acts as a
     -- 'default' indent for languages like Python, where the NeoVim or Treesitter
     -- indenter doesn't know how to indent them.
-    local current_line = vim.api.nvim_get_current_line()
-    local leading_space = current_line:match("^(%s+)") or ""
+    local leading_space = vim.api.nvim_get_current_line():match("^(%s+)") or ""
+
+    local current_line_nr = vim.api.nvim_win_get_cursor(0)[1]
+    local line_to_insert_linenr
 
     if opts.above then
         line_to_insert_linenr = current_line_nr - 1
@@ -136,7 +153,7 @@ local addline = function(opts)
         line_to_insert_linenr,
         line_to_insert_linenr,
         true,
-        { leading_space .. line_to_insert_content }
+        { leading_space .. line_to_insert }
     )
 
     utils.indent_line(line_to_insert_linenr, global_opts.move_to_debugline)
@@ -146,11 +163,7 @@ local cache_request = nil
 
 M.debugprint_cache = function(opts)
     if opts and opts.prerepeat == true then
-        if not filetype_configured() then
-            return
-        end
-
-        if opts.variable == true then
+        if filetype_configured() and opts.variable == true then
             opts.variable_name = utils.get_variable_name(
                 global_opts.ignore_treesitter,
                 opts.ignore_treesitter

lua/debugprint/utils.lua

@@ -51,7 +51,10 @@ M.get_variable_name = function(
         variable_name = vim.fn.input("Variable name: ", word_under_cursor)
 
         if variable_name == nil or variable_name == "" then
-            vim.notify("No variable name entered.", vim.log.levels.WARN)
+            -- Don't show a warning because of this issue:
+            -- https://github.com/andrewferrier/debugprint.nvim/issues/91.
+            -- Instead just silently end debugprint operation.
+            vim.cmd("mode") -- Clear command
             return false
         end
     end
@@ -180,10 +183,11 @@ M.get_visual_selection = function()
     end
 
     if line1 ~= line2 then
-        vim.notify(
-            "debugprint not supported when multiple lines selected.",
-            vim.log.levels.ERROR
-        )
+        -- Multiple lines are selected; in this case, silently fail to find a
+        -- visual selection, since it's unlikely to be what the user wants
+        -- anyway, and there's no good way to give them an error (vim.notify()
+        -- may fail because of an issue similar to this:
+        -- https://github.com/andrewferrier/debugprint.nvim/issues/91).
         return false
     end
 
@@ -199,6 +203,8 @@ M.get_operator_selection = function()
     local col2 = last_pos[3]
 
     if line1 ~= line2 then
+        -- This seems to work OK with nvim-notify and is not affected by
+        -- https://github.com/andrewferrier/debugprint.nvim/issues/91
         vim.notify(
             "debugprint not supported when multiple lines in motion.",
             vim.log.levels.ERROR

tests/debugprint.lua

@@ -402,14 +402,13 @@ describe("can do variable debug statement insertion", function()
         })
     end)
 
-    it("entering no name gives an error", function()
+    it("entering no name silently ends debugprint operation", function()
         init_file({
             "foo",
             "bar",
         }, "lua", 1, 0)
 
         feedkeys("g?v<BS><BS><BS><CR>")
-        assert.are.same("No variable name entered.", notify_message)
 
         check_lines({
             "foo",
@@ -462,17 +461,42 @@ describe("can do various file types", function()
         }, "foo", 1, 0, { filetype = "foo" })
 
         feedkeys("g?p")
-        assert.are.same(
-            "Don't have debugprint configuration for filetype foo",
-            notify_message
-        )
 
-        check_lines({
-            "foo",
-            "bar",
-        })
+        if vim.fn.has("nvim-0.9.0") == 1 then
+            check_lines({
+                "foo",
+                "Don't have debugprint configuration for filetype foo; see https://github.com/andrewferrier/debugprint.nvim?tab=readme-ov-file#add-custom-filetypes",
+                "bar",
+            })
+        else
+            check_lines({
+                "foo",
+                "/*Don't have debugprint configuration for filetype foo; see https://github.com/andrewferrier/debugprint.nvim?tab=readme-ov-file#add-custom-filetypes*/",
+                "bar",
+            })
+        end
     end)
 
+    it(
+        "can gracefully handle known filetypes we don't have a config for: fennel",
+        function()
+            init_file({
+                "(fn print-and-add [a b c]",
+                "  (print a)",
+                "  (+ b c))",
+            }, "fnl", 1, 0)
+
+            feedkeys("g?p")
+
+            check_lines({
+                "(fn print-and-add [a b c]",
+                "  ;Don't have debugprint configuration for filetype fennel; see https://github.com/andrewferrier/debugprint.nvim?tab=readme-ov-file#add-custom-filetypes",
+                "  (print a)",
+                "  (+ b c))",
+            })
+        end
+    )
+
     it("don't prompt for a variable name with an unknown filetype", function()
         init_file({
             "foo",
@@ -481,15 +505,20 @@ describe("can do various file types", function()
 
         feedkeys("g?v")
         feedkeys("<CR>")
-        assert.are.same(
-            "Don't have debugprint configuration for filetype foo",
-            notify_message
-        )
 
-        check_lines({
-            "foo",
-            "bar",
-        })
+        if vim.fn.has("nvim-0.9.0") == 1 then
+            check_lines({
+                "foo",
+                "Don't have debugprint configuration for filetype foo; see https://github.com/andrewferrier/debugprint.nvim?tab=readme-ov-file#add-custom-filetypes",
+                "bar",
+            })
+        else
+            check_lines({
+                "foo",
+                "/*Don't have debugprint configuration for filetype foo; see https://github.com/andrewferrier/debugprint.nvim?tab=readme-ov-file#add-custom-filetypes*/",
+                "bar",
+            })
+        end
     end)
 end)
 
@@ -1093,10 +1122,11 @@ describe("visual selection", function()
 
         feedkeys("vjg?v")
 
-        assert.are.same(
-            "debugprint not supported when multiple lines selected.",
-            notify_message
-        )
+        check_lines({
+            "function x()",
+            "local xyz = 3",
+            "end",
+        })
     end)
 end)