Block mode commenting not working with Comment.nvim about nvim-ts-context-commentstring

[JoosepAlviste]

Hey!

It should not be required to have anything else configured for this plugin. Here's my configuration (very minimal):

-- ... nvim-treesitter config
  context_commentstring = {
    enable = true,
    enable_autocmd = false,
  },

-- Comment.nvim config
require('Comment').setup {
  pre_hook = require('ts_context_commentstring.integrations.comment_nvim').create_pre_hook(),
}

Which results in:

Screen.Recording.2022-12-27.at.18.38.09.mov

Where I'm visually selecting the lines and using gc (and gcj) to comment/uncomment.

I see that one difference we have is that in my case, the commentstring is applied on each line separately, but on yours, it's applied to the start of the first line and the ending of the second line. Maybe this has something to do with it?

Could you share your exact configuration and steps to reproduce (with specific keys pressed)?

[diegoulloao]

Hey thanks for your response!
I'll do it when I have time, now trying to fix an urgent issue. I'll keep you updated on this okay?

[diegoulloao]

Hey, yes, the difference is I'm using the visual mode with the block commenter:

comment.setup({
  -- toggle mappings in normal mode
  toggler = {
    -- line comment toggle keymap
    line = "<leader>c<leader>",
  },
  -- opleader mappings in visual mode
  opleader = {
    -- multiline comment toogle keymap
    block = "<leader>c<leader>",
  },
  -- nvim-ts-context-commentstring integration
  pre_hook = context_commentstring_integration.create_pre_hook(),
})

So if I'm the current line in normal mode it will work as line comment, if is visual mode, as block comment (for multiple line selecting).

Maybe that may be causing my issue?
BTW, I'm using the same keybinding for comment/uncomment (toggle) depending of the nvim mode.

[JoosepAlviste]

Thanks for the example config! I was able to reproduce the issue with your Comment.nvim configuration.

It looks like we previously used the cursor location for calculating the commentstring, but we should have been using the visual selection start location. Not sure how this wasn't breaking with the default configuration 🤔

Anyways, I set up a PR: #54 Could you try it out and see if it fixes the issue for you as well?

[diegoulloao]

Hey thank you for the quick fix! I've tested and is working for me. Also it seems isn't breaking other sort of comments 👌🏻
✅

[JoosepAlviste]

Sweet, thanks for the bug report and the help!