Use treesitter to make insertion of debuglines smarter

[jakubbortlik]

Hi @andrewferrier, thanks for your amazing plugin! I'm using it daily in my work. One thing that keeps bugging me, however, is the pasting of debugprint lines inside multiline statements.

Example

With the cursor on the file variable:

file = requests.get(
    data["result"]["file_url"]
)

When I type g?v, I get the following:

file = requests.get(
        print(f"DEBUGPRINT[1]: ahoj.py:29: file={file}")
    data["result"]["file_url"]
)

Instead, what the mapping should produce is:

file = requests.get(
    data["result"]["file_url"]
)
print(f"DEBUGPRINT[1]: ahoj.py:29: file={file}")

This is what ThePrimeagen/refactoring.nvim produces for comparison:

file = requests.get(
    data["result"]["file_url"]
)
# __AUTO_GENERATED_PRINT_VAR_START__
print(f" file: {str(file)}") # __AUTO_GENERATED_PRINT_VAR_END__

[andrewferrier]

@jakubbortlik thanks for this. Yes, I'm aware of this, and if it makes you feel any better, I find it annoying too! ;)

The challenge is that today, debugprint is written in such a way that it doesn't explicitly use treesitter, except to extract information about variables - it's not aware of the language structure. I know other plugins are better at this, and ideally, it's something I'd like to fix in debugprint, but it's not an easy job, especially considering the number of languages which debugprint supports - although I'd probably start with the easier ones.

It is a problem, though, and thanks for making me aware that it annoys you, it helps me prioritize my work on the plugin. I'll keep this open and hopefully start work on it soon. Any other help/thoughts appreciated.

[jakubbortlik]

Thanks for your response. I'm wondering whether there could be some "simple" solution based on the built-in functionality of the normal mode keybinding % that jumps to a matching bracket or parenthesis. This is just what I would normally do manually: create the debugprint statement and if it happens to end up within a multiline statement, I just delete it, go back to the variable that I want to print, use % to go to the right place and then use =p from the unimpaired plugin to paste with re-indenting. I imagine that when adding a debug statement debugprint.nvim could do the following:

1. construct the debug message
2. try to simulate a % press
3. paste the debug line
4. simulate pressing == to reindent the current line (this would probably require making sure that equalprg and indentexpr are set to something meaningful)

[andrewferrier]

Well, the good news is that we already do step (4) anyway ;). See

debugprint.nvim/lua/debugprint/utils/buffer.lua

Line 25 in f76ceee

vim.api.nvim_cmd({

.

Let me think about this. It's certainly an interesting idea, I just want to test it out with a few filetypes to see how robust it is and check it's not too 'hacky'.

[andrewferrier]

Hmm, I'm not sure how robust that algorithm is. For example, if you put your cursor on data in your first example, then hit %, it doesn't take you anywhere useful for inserting a statement :(

[jakubbortlik]

Hmm, I'm not sure how robust that algorithm is. For example, if you put your cursor on data in your first example, then hit %, it doesn't take you anywhere useful for inserting a statement :(

Right, the approach I outlined would just work for a limited number of cases. A tree-sitter based approach will definitely be more reliable.

In the meantime, I will probably figure out some custom mapping that will solve the basic use case (cursor on file in my example).