Breaking changes

[andrewferrier]

Please subscribe to this issue to be informed of any breaking changes to debugprint.nvim.

[andrewferrier]

As of commit a8900d7fc, all default keymappings have been changed to start with g?. The 4 defaults are now:

• g?p - debug line below
• g?P - debug line above
• g?v - variable line below
• g?V - variable above

Apologies for making this change so early in the lifetime of debugprint, but I realized that dqp was too limiting for supporting other NeoVim modes (e.g. forthcoming visual mode), and I decided to make the change now to prioritize consistency whilst folks are still picking up the plugin. I do not plan to change these defaults regularly!

The old keybindings will continue to work for a while, with a warning message.

If you want to continue to use the previous/old keybindings permanently, please set your configuration up like this. Note that this will require you to keep maintaining custom keybindings in the future when we introduce others.

NOTE: Please no longer do this, this is just kept for reference. Keybindings are now set up this way: #25 (comment)

    use({
        "andrewferrier/debugprint.nvim",
        config = function()
            require("debugprint").setup({ create_keymaps = false })
        end,
    })

    vim.keymap.set("n", "dqp", function()
        return require('debugprint').debugprint()
    end, {
        expr = true,
    })
    vim.keymap.set("n", "dqP", function()
        return require('debugprint')({ above = true })
    end, {
        expr = true,
    })
    vim.keymap.set("n", "dQp", function()
        return require('debugprint')({ variable = true })
    end, {
        expr = true,
    })
    vim.keymap.set("n", "dQP", function()
        return require('debugprint')({ above = true, variable = true })
    end, {
        expr = true,
     })

[andrewferrier]

This is technically not a breaking change, but commit ffaaee1 includes a change to the default plain (not variable) debug lines such that they contain a snippet of the line above or below them, to help orientate you when viewing output.

I think this is really helpful, but if you don't like this change, you can go back to the old behaviour by setting the global option display_snippet to false.

[andrewferrier]

As of commit e1827741b7b8, debugprint.nvim requires NeoVim 0.8+ and will issue a warning on startup if it's not present. This is because nvim-treesitter has required 0.8+ for some time, and although this is only an optional dependency for debugprint.nvim, it causes some of the tests to break and we cannot afford the overhead of managing the behaviour separately for 0.7.

If you are still using NeoVim 0.7, for now your choices are to ignore the warning (debugprint.nvim will still work, except for the treesitter functionality) or to pin your package manager to commit f8e7abd054 for debugprint.nvim. The latter will only eliminate the warning, you still won't be able to use treesitter keybindings until you upgrade to 0.8+.

[andrewferrier]

As of commit 7c3a43cf1, some filetypes now use print logic that will print to stderr rather than stdout - as had been raised in #48, this is more logical since these are debugging/error messages and for some types of development/testing that may be important. For those using debugprint in a fairly casual way you should generally not see any difference although for some filetypes you may need to tweak your imported modules etc. Some filetypes are still to be migrated to this new approach and #48 remains open to track them.

[andrewferrier]

As of commit ee9d6ffa, the mechanism for setting up keymappings or commands for debugprint.nvim has changed to resolve some issues some users saw with custom mapping of keys - see GitHub issue #44 for the history. If you didn't customize the default keymappings or commands before, you shouldn't have to change anything. However, if you did, you should switch to the new mechanism instead. Please see README for an explanation of the new mechanism. Old keymapping configuration should continue to work for now, although direct keymapping via vim.keymap.set() is no longer officially supported and may be removed in future, and you may see deprecation warnings.

[andrewferrier]

As of commit be12ffc, the use of the ignore_treesitter option at a global level has been softly deprecated by removal from the documentation and is discouraged. You can achieve the same effect by using the variable_below_alwaysprompt and variable_above_alwaysprompt keybindings rather than variable_below and variable_above - just configure those in your setup() function as per the documentation.

In a later release, this option will be hard-deprecated and will start generating a warning on use.

[andrewferrier]

As of commit 48505a2 (not yet in a released version, but on the main branch), you will start seeing deprecation warnings if you are still mapping to the debugprint() function directly - please see #25 (comment) for previous discussion on this issue. Please switch to the configuration-based way of setting up your keymaps if you haven't already.

[andrewferrier]

In version 7.0, legacy (undocumented) commands like DeleteDebugPrints, ToggleCommentDebugPrints, etc. have been removed. See #200 for the reasoning. All commands are now accessed as subcommands through Debugprint <subcommand>. See the documentation for the names of those commands: https://github.com/andrewferrier/debugprint.nvim?tab=readme-ov-file#keymappings-and-commands