patch 9.1.0464: no whitespace padding in commentstring option in ftpluginsv9.1.0464

Problem:  no whitespace padding in commentstring option in ftplugins
Solution: Change default to include whitespace padding, update
          existing filetype plugins with the new default value
          (Riley Bruins)

closes: #14843

Signed-off-by: Riley Bruins <ribru17@hotmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>

71 files changed, 305 insertions, 162 deletions

diff --git a/.github/MAINTAINERS b/.github/MAINTAINERS
index dbc04868f6..91c3284afd 100644
--- a/.github/MAINTAINERS
+++ b/.github/MAINTAINERS
@@ -179,6 +179,7 @@ runtime/ftplugin/kotlin.vim		@udalov
 runtime/ftplugin/less.vim		@genoma
 runtime/ftplugin/liquid.vim		@tpope
 runtime/ftplugin/lua.vim		@dkearns
+runtime/ftplugin/lc.vim			@ribru17
 runtime/ftplugin/lynx.vim		@dkearns
 runtime/ftplugin/m3build.vim		@dkearns
 runtime/ftplugin/m3quake.vim		@dkearns
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index e28244f111..bc7f687139 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1909,13 +1909,14 @@ A jump table for the options with a short description can be found at |Q_op|.
 	insert a space.
 
 					*'commentstring'* *'cms'* *E537*
-'commentstring' 'cms'	string	(default "/*%s*/")
+'commentstring' 'cms'	string	(default "/* %s */")
 			local to buffer
 			{not available when compiled without the |+folding|
 			feature}
 	A template for a comment.  The "%s" in the value is replaced with the
-	comment text.  Currently only used to add markers for folding, see
-	|fold-marker|.  Also used by comment plugins |comment-install|.
+	comment text, and should be padded with a space when possible.
+	Currently used to add markers for folding, see |fold-marker| also
+	commonly used by commenting plugins (e.g. |comment-install|).
 
 			*'compatible'* *'cp'* *'nocompatible'* *'nocp'*
 'compatible' 'cp'	boolean	(default on, off when a |vimrc| or |gvimrc|
diff --git a/runtime/doc/version9.txt b/runtime/doc/version9.txt
index 3473d796fe..3fe8b2dad0 100644
--- a/runtime/doc/version9.txt
+++ b/runtime/doc/version9.txt
@@ -41565,6 +41565,8 @@ Changed~
 -------
 - use 'smoothscroll' logic for CTRL-F and CTRL-B for pagewise scrolling
 - use 'smoothscroll' logic for CTRL-D and CTRL-U for half-pagewise scrolling
+- the default for 'commentstring' contains whitespace padding to have
+  automatic comments look nicer |comment-install|
 
 							*added-9.2*
 Added ~
diff --git a/runtime/ftplugin/abaqus.vim b/runtime/ftplugin/abaqus.vim
index c16e7b032e..d4bb6fe777 100644
--- a/runtime/ftplugin/abaqus.vim
+++ b/runtime/ftplugin/abaqus.vim
@@ -3,6 +3,7 @@
 " Maintainer:   Carl Osterwisch <costerwi@gmail.com>
 " Last Change:  2022 Oct 08
 "               2024 Jan 14 by Vim Project (browsefilter)
+"               2024 May 23 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 " Only do this when not done yet for this buffer
 if exists("b:did_ftplugin") | finish | endif
@@ -27,7 +28,7 @@ setlocal isfname-=,
 
 " Define format of comment lines (see 'formatoptions' for uses)
 setlocal comments=:**
-setlocal commentstring=**%s
+setlocal commentstring=**\ %s
 
 " Definitions start with a * and assign a NAME, NSET, or ELSET
 " Used in [d ^wd and other commands
diff --git a/runtime/ftplugin/arduino.vim b/runtime/ftplugin/arduino.vim
index dae3dd83d3..60b11dab1a 100644
--- a/runtime/ftplugin/arduino.vim
+++ b/runtime/ftplugin/arduino.vim
@@ -3,6 +3,7 @@
 " Maintainer:	The Vim Project <https://github.com/vim/vim>
 "		Ken Takata <https://github.com/k-takata>
 " Last Change:	2024 Apr 12
+"		2024 Jun 02 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 "
 " Most of the part was copied from c.vim.
 
@@ -32,7 +33,7 @@ setlocal fo-=t fo+=croql
 
 " These options have the right value as default, but the user may have
 " overruled that.
-setlocal commentstring& define& include&
+setlocal commentstring=/*\ %s\ */ define& include&
 
 " Set completion with CTRL-X CTRL-O to autoloaded function.
 if exists('&ofu')
diff --git a/runtime/ftplugin/asm.vim b/runtime/ftplugin/asm.vim
index 0ae1610394..4482b90d0b 100644
--- a/runtime/ftplugin/asm.vim
+++ b/runtime/ftplugin/asm.vim
@@ -4,13 +4,14 @@
 " Last Change:	2020 May 23
 " 		2023 Aug 28 by Vim Project (undo_ftplugin)
 " 		2024 Apr 09 by Vim Project (add Matchit support)
+" 		2024 May 23 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists("b:did_ftplugin") | finish | endif
 let b:did_ftplugin = 1
 
 setl include=^\\s*%\\s*include
 setl comments=:;,s1:/*,mb:*,ex:*/,://
-setl commentstring=;%s
+setl commentstring=;\ %s
 
 let b:undo_ftplugin = "setl commentstring< comments< include<"
 
diff --git a/runtime/ftplugin/astro.vim b/runtime/ftplugin/astro.vim
index 0b0e03447b..5d35ba9624 100644
--- a/runtime/ftplugin/astro.vim
+++ b/runtime/ftplugin/astro.vim
@@ -2,6 +2,7 @@
 " Language:     Astro
 " Maintainer:   Romain Lafourcade <romainlafourcade@gmail.com>
 " Last Change:  2024 Apr 21
+"               2024 May 24 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists("b:did_ftplugin")
     finish
@@ -25,17 +26,17 @@ function! s:AstroComments() abort
                 \ || s:IdentifyScope('^\s*<script', '^\s*<\/script>')
         " ECMAScript comments
         setlocal comments=sO:*\ -,mO:*\ \ ,exO:*/,s1:/*,mb:*,ex:*/,://
-        setlocal commentstring=//%s
+        setlocal commentstring=//\ %s
 
     elseif s:IdentifyScope('^\s*<style', '^\s*<\/style>')
         " CSS comments
         setlocal comments=s1:/*,mb:*,ex:*/
-        setlocal commentstring=/*%s*/
+        setlocal commentstring=/*\ %s\ */
 
     else
         " HTML comments
         setlocal comments=s:<!--,m:\ \ \ \ ,e:-->
-        setlocal commentstring=<!--%s-->
+        setlocal commentstring=<!--\ %s\ -->
     endif
 endfunction
 
diff --git a/runtime/ftplugin/bitbake.vim b/runtime/ftplugin/bitbake.vim
index 99fe334627..4d50a7feb7 100644
--- a/runtime/ftplugin/bitbake.vim
+++ b/runtime/ftplugin/bitbake.vim
@@ -3,13 +3,14 @@
 " Maintainer: Gregory Anders <greg@gpanders.com>
 " Repository: https://github.com/openembedded/bitbake
 " Latest Revision: 2022-07-23
+"                  2024-05-23 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists("b:did_ftplugin")
   finish
 endif
 let b:did_ftplugin = 1
 
-setlocal commentstring=#%s
+setlocal commentstring=#\ %s
 setlocal comments=:#
 setlocal suffixesadd=.bb,.bbclass
 
diff --git a/runtime/ftplugin/c.vim b/runtime/ftplugin/c.vim
index e2eebc5492..378d58065a 100644
--- a/runtime/ftplugin/c.vim
+++ b/runtime/ftplugin/c.vim
@@ -2,6 +2,7 @@
 " Language:	C
 " Maintainer:	The Vim Project <https://github.com/vim/vim>
 " Last Change:	2023 Aug 22
+"		2024 Jun 02 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 " Former Maintainer:	Bram Moolenaar <Bram@vim.org>
 
 " Only do this when not done yet for this buffer
@@ -24,7 +25,7 @@ setlocal fo-=t fo+=croql
 
 " These options have the right value as default, but the user may have
 " overruled that.
-setlocal commentstring& define& include&
+setlocal commentstring=/*\ %s\ */ define& include&
 
 " Set completion with CTRL-X CTRL-O to autoloaded function.
 if exists('&ofu')
diff --git a/runtime/ftplugin/calendar.vim b/runtime/ftplugin/calendar.vim
index f454ba1dc8..c4e683acf6 100644
--- a/runtime/ftplugin/calendar.vim
+++ b/runtime/ftplugin/calendar.vim
@@ -2,6 +2,7 @@
 " Language:             calendar(1) input file
 " Previous Maintainer:  Nikolai Weibull <now@bitwi.se>
 " Latest Revision:      2008-07-09
+"                       2024-06-02 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists("b:did_ftplugin")
   finish
@@ -13,7 +14,7 @@ set cpo&vim
 
 let b:undo_ftplugin = "setl com< cms< inc< fo<"
 
-setlocal comments=s1:/*,mb:*,ex:*/ commentstring& include&
+setlocal comments=s1:/*,mb:*,ex:*/ commentstring=/*\ %s\ */ include&
 setlocal formatoptions-=t formatoptions+=croql
 
 let &cpo = s:cpo_save
diff --git a/runtime/ftplugin/cgdbrc.vim b/runtime/ftplugin/cgdbrc.vim
index 46cf135c5c..99f9702d26 100644
--- a/runtime/ftplugin/cgdbrc.vim
+++ b/runtime/ftplugin/cgdbrc.vim
@@ -3,6 +3,7 @@
 " Maintainer:           Wu, Zhenyu <wuzhenyu@ustc.edu>
 " Documentation:        https://cgdb.github.io/docs/Configuring-CGDB.html
 " Latest Revision:      2024-04-09
+"                       2024-05-23 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists('b:did_ftplugin')
   finish
@@ -14,7 +15,7 @@ set cpoptions&vim
 
 let b:undo_ftplugin = 'setl com< cms<'
 
-setlocal commentstring=#%s
+setlocal commentstring=#\ %s
 setlocal comments=:#
 
 let &cpoptions = s:save_cpoptions
diff --git a/runtime/ftplugin/csh.vim b/runtime/ftplugin/csh.vim
index a22bee3279..74666b9680 100644
--- a/runtime/ftplugin/csh.vim
+++ b/runtime/ftplugin/csh.vim
@@ -4,6 +4,7 @@
 " Previous Maintainer:	Dan Sharp
 " Contributor:		Johannes Zellner <johannes@zellner.org>
 " Last Change:		2024 Jan 14
+" 			2024 May 23 by Riley Bruins ('commentstring')
 
 if exists("b:did_ftplugin")
   finish
@@ -14,7 +15,7 @@ let s:save_cpo = &cpo
 set cpo-=C
 
 setlocal comments=:#
-setlocal commentstring=#%s
+setlocal commentstring=#\ %s
 setlocal formatoptions-=t
 setlocal formatoptions+=crql
 
diff --git a/runtime/ftplugin/css.vim b/runtime/ftplugin/css.vim
index ece2def4ee..778a9e12d6 100644
--- a/runtime/ftplugin/css.vim
+++ b/runtime/ftplugin/css.vim
@@ -3,6 +3,7 @@
 " Maintainer:		Doug Kearns <dougkearns@gmail.com>
 " Previous Maintainer:	Nikolai Weibull <now@bitwi.se>
 " Last Change:		2020 Dec 21
+"			2024 Jun 02 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists("b:did_ftplugin")
   finish
@@ -14,7 +15,7 @@ set cpo&vim
 
 let b:undo_ftplugin = "setl com< cms< inc< fo< ofu< isk<"
 
-setlocal comments=s1:/*,mb:*,ex:*/ commentstring&
+setlocal comments=s1:/*,mb:*,ex:*/ commentstring=/*\ %s\ */
 setlocal formatoptions-=t formatoptions+=croql
 setlocal omnifunc=csscomplete#CompleteCSS
 setlocal iskeyword+=-
diff --git a/runtime/ftplugin/desktop.vim b/runtime/ftplugin/desktop.vim
index bd6fd7097c..d15afd24b9 100644
--- a/runtime/ftplugin/desktop.vim
+++ b/runtime/ftplugin/desktop.vim
@@ -2,6 +2,7 @@
 " Language: XDG desktop entry
 " Maintainer: Eisuke Kawashima ( e.kawaschima+vim AT gmail.com )
 " Last Change: 2022-07-26
+"              2024-05-24 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists('b:did_ftplugin')
   finish
@@ -9,5 +10,5 @@ endif
 let b:did_ftplugin = v:true
 
 setl comments=:#
-setl commentstring=#%s
+setl commentstring=#\ %s
 let b:undo_ftplugin = 'setl com< cms<'
diff --git a/runtime/ftplugin/dtd.vim b/runtime/ftplugin/dtd.vim
index bea8c5c18a..f97014814b 100644
--- a/runtime/ftplugin/dtd.vim
+++ b/runtime/ftplugin/dtd.vim
@@ -6,6 +6,7 @@
 " Former maintainer:	Dan Sharp
 " Last Change:		2009 Jan 20
 "			2024 Jan 14 by Vim Project (browsefilter)
+"			2024 May 23 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists("b:did_ftplugin") | finish | endif
 let b:did_ftplugin = 1
@@ -15,7 +16,7 @@ let b:did_ftplugin = 1
 let s:save_cpo = &cpo
 set cpo-=C
 
-setlocal commentstring=<!--%s-->
+setlocal commentstring=<!--\ %s\ -->
 setlocal comments=s:<!--,m:\ \ \ \ \ ,e:-->
 
 setlocal formatoptions-=t
diff --git a/runtime/ftplugin/dtrace.vim b/runtime/ftplugin/dtrace.vim
index 9288097f7f..a276b310a3 100644
--- a/runtime/ftplugin/dtrace.vim
+++ b/runtime/ftplugin/dtrace.vim
@@ -1,6 +1,7 @@
 " Language: D script as described in "Solaris Dynamic Tracing Guide",
 "           http://docs.sun.com/app/docs/doc/817-6223
 " Last Change: 2008/03/20
+"              2024/05/23 by Riley Bruins <ribru17@gmail.com ('commentstring')
 " Version: 1.2
 " Maintainer: Nicolas Weber <nicolasweber@gmx.de>
 
@@ -26,8 +27,8 @@ setlocal fo-=t fo+=croql
 setlocal comments=sO:*\ -,mO:*\ \ ,exO:*/,s1:/*,mb:*,ex:*/
 
 " dtrace uses /* */ comments. Set this explicitly, just in case the user
-" changed this (/*%s*/ is the default)
-setlocal commentstring=/*%s*/
+" changed this (/*\ %s\ */ is the default)
+setlocal commentstring=/*\ %s\ */
 
 setlocal iskeyword+=@,$
 
diff --git a/runtime/ftplugin/dts.vim b/runtime/ftplugin/dts.vim
index 42e38338b7..346ff94704 100644
--- a/runtime/ftplugin/dts.vim
+++ b/runtime/ftplugin/dts.vim
@@ -2,6 +2,7 @@
 " Language:             dts/dtsi (device tree files)
 " Maintainer:           Wu, Zhenyu <wuzhenyu@ustc.edu>
 " Latest Revision:      2024 Apr 12
+"                       2024 Jun 02 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists('b:did_ftplugin')
   finish
@@ -12,5 +13,5 @@ let b:undo_ftplugin = 'setl inc< cms< com<'
 
 setlocal include=^\\%(#include\\\|/include/\\)
 " same as C
-setlocal commentstring&
+setlocal commentstring=/*\ %s\ */
 setlocal comments=sO:*\ -,mO:*\ \ ,exO:*/,s1:/*,mb:*,ex:*/,:///,://
diff --git a/runtime/ftplugin/erlang.vim b/runtime/ftplugin/erlang.vim
index 1cb57f4c85..5a3ab717d9 100644
--- a/runtime/ftplugin/erlang.vim
+++ b/runtime/ftplugin/erlang.vim
@@ -6,7 +6,8 @@
 "               Eduardo Lopez (http://github.com/tapichu)
 "               Arvid Bjurklint (http://github.com/slarwise)
 "               Paweł Zacharek (http://github.com/subc2)
-" Last Update:  2023-Dec-20
+"               Riley Bruins (http://github.com/ribru17) ('commentstring')
+" Last Update:  2024 May 23
 " License:      Vim license
 " URL:          https://github.com/vim-erlang/vim-erlang-runtime
 
@@ -27,7 +28,7 @@ if get(g:, 'erlang_folding', 0)
 endif
 
 setlocal comments=:%%%,:%%,:%
-setlocal commentstring=%%s
+setlocal commentstring=%\ %s
 
 setlocal formatoptions+=ro
 
diff --git a/runtime/ftplugin/eruby.vim b/runtime/ftplugin/eruby.vim
index b5c4665d24..b3e074aa20 100644
--- a/runtime/ftplugin/eruby.vim
+++ b/runtime/ftplugin/eruby.vim
@@ -5,6 +5,7 @@
 " Release Coordinator:	Doug Kearns <dougkearns@gmail.com>
 " Last Change:		2022 May 15
 "			2024 Jan 14 by Vim Project (browsefilter)
+"			2024 May 23 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 " Only do this when not done yet for this buffer
 if exists("b:did_ftplugin")
@@ -125,7 +126,7 @@ if exists("loaded_matchit")
 endif
 
 " TODO: comments=
-setlocal commentstring=<%#%s%>
+setlocal commentstring=<%#\ %s\ %>
 
 let b:undo_ftplugin = "setl cms< " .
       \ " | unlet! b:browsefilter b:match_words | " . b:undo_ftplugin
diff --git a/runtime/ftplugin/fennel.vim b/runtime/ftplugin/fennel.vim
index 93cf366726..2a9623faff 100644
--- a/runtime/ftplugin/fennel.vim
+++ b/runtime/ftplugin/fennel.vim
@@ -2,13 +2,14 @@
 " Language:     Fennel
 " Maintainer:   Gregory Anders <greg[NOSPAM]@gpanders.com>
 " Last Update:  2023 Jun 9
+"               2024 May 24 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists('b:did_ftplugin')
   finish
 endif
 let b:did_ftplugin = 1
 
-setlocal commentstring=;%s
+setlocal commentstring=;\ %s
 setlocal comments=:;;,:;
 setlocal formatoptions-=t
 setlocal suffixesadd=.fnl
diff --git a/runtime/ftplugin/fish.vim b/runtime/ftplugin/fish.vim
index f06ad3a0bf..55d7ea8dd9 100644
--- a/runtime/ftplugin/fish.vim
+++ b/runtime/ftplugin/fish.vim
@@ -4,6 +4,7 @@
 " Repository:   https://github.com/nickeb96/fish.vim
 " Last Change:  February 1, 2023
 "               2023 Aug 28 by Vim Project (undo_ftplugin)
+"               2024 May 23 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 if exists("b:did_ftplugin")
     finish
@@ -12,7 +13,7 @@ let b:did_ftplugin = 1
 
 setlocal iskeyword=@,48-57,_,192-255,-,.
 setlocal comments=:#
-setlocal commentstring=#%s
+setlocal commentstring=#\ %s
 setlocal formatoptions+=crjq
 
 let b:undo_ftplugin = "setl cms< com< fo< isk<"
diff --git a/runtime/ftplugin/fortran.vim b/runtime/ftplugin/fortran.vim
index 3c325818d3..19a4c1e62b 100644
--- a/runtime/ftplugin/fortran.vim
+++ b/runtime/ftplugin/fortran.vim
@@ -11,6 +11,7 @@
 "  Doug Kearns, and Fritz Reese.
 " Last Change:	2023 Dec 22
 "		2024 Jan 14 by Vim Project (browsefilter)
+"		2024 May 23 by Riley Bruins <ribru17@gmail.com> ('commentstring')
 
 " Only do these settings when not done yet