No space between comment and code about vim-commentary

[atweiden]

+1

[jpflouret]

+1

Should it be optional based on commentstring? Such that with commentstring=//%s you get:

//var example = "hi";
//var anotherExample = "hello";

But with commentstring=//\ %s you get

// var example = "hi";
// var anotherExample = "hello";

[tpope]

And then what? Users can go and override every ftplugin's commentstring one by one in order to micromanage it?

[jpflouret]

I was under the impression that commentstring was supposed to be how to format a comment in a given language and the plugin does not follow the format since it adds spaces around the given format. It stands to reason that if people want a different format for their comments then they would need to alter commentstring per file type they care.

I believe the current setting is inconsistent with vim's usage of commentstring since when you create a fold (with foldmethod=marker) the comment that vim introduces does not add spaces around the %s.

I don't know how else you would do that without introducing a global configuration variable which seems very ugly.

Or am I missing something?

[tpope]

It's a practical consideration. About 2/3rds of Vim's default comment strings have spaces and about a 1/3rd don't. This has little to do with language consideration and everything to do with the whims of maintainers. I chose to add the space on those in the 1/3rd rather than subject the user to an arbitrary mess.

You're correct about foldmethod, but since foldmarkers count as "useful comments", your solution is now directly opposed to the original request.

One compromise might be to exempt b:commentary_format from the whitespace normalization, since that's free of defaults.

[jpflouret]

I see. If we remove comentary_format from the normalization then users could have an autocmd/ftplugin to set commentary_format to whatever they please. Your compromise would be acceptable to me.

[jpflouret]

Thank you!