[mini.comment] Doesn't work for Verilog, SystemVerilog, and Arduino files

[usman1515]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.comment

Question

While working on my code I found out that mini.comment doesn’t comment lines in Verilog (.v), SystemVerilog (.sv), and Arduino (.ino) files. Instead, it throws the error:

mini.comment() object commentstring is empty.

I was able to fix it by explicitly setting commentstring in the pre hook like this:

require("mini.comment").setup({
    hooks = {
        pre = function()
            local ft = vim.bo.filetype
            if ft == "verilog" or ft == "systemverilog" or ft == "arduino" then
                vim.bo.commentstring = "// %s"
            end
        end,
    },
})

Not sure if this is a bug, a missing default configuration, or a dependency issue. Should this be handled internally by mini.comment, or is it expected that users manually configure commentstring for these file types?

[krovuxdev]

@usman1515 It's not a bug or a missing dependency. The issue is that Neovim doesn't define commentstring for these file types by default. I had the same problem with yuck and lisp. mini.comment didn't work until I created nvim/after/ftplugin/yuck.lua with:

vim.opt_local.commentstring = "; %s"

I'm sure this is not related to mini.comment. The real issue is that Neovim doesn't set commentstring for Arduino or SystemVerilog by default.

For example, Rust and Python have commentstring set automatically because Neovim already supports them.

or is it expected that users manually configure commentstring for these file types?

Yes, you need to set it manually. Neovim doesn't define it by default for these file types.

[echasnovski]

Yes, this is correct. Inferring comment structure from 'commentstring' is a documented behavior.

One small thing I'd change is to use vim.bo.commentstring instead of vim.opt_local.commentstring. As the latter is probably going to be deprecated in the future.

[usman1515]

Noted.
I recently started using nvim full time as my editor of choice. I was initially using numToStr/Comment.nvim and it provided support out of the box for all code files that I have used so far. Came to know of mini.nvim 1-2 weeks ago and incorporated the mini.comment plugin so I thought maybe it was plugin problem or something similar.

Thanks again