feat: Add commentstring for vim plugin (snakemake#3104)

vandalt · web-flow · commit bd0d36ebff35 · 2025-01-06T16:39:02.000+01:00
Enables toggling comments with commenting plugins or Neovim's built-in
`gcc` mapping

&lt;!--Add a description of your PR here--&gt;

### QC
&lt;!-- Make sure that you can tick the boxes below. --&gt;

* [x] The PR contains a test case for the changes or the changes are
already covered by an existing test case. (**NA, I think**)
* [x] The documentation (`docs/`) is updated to reflect the changes or
this is not necessary (e.g. if the change does neither modify the
language nor the behavior or functionalities of Snakemake). (**NA too, I
think**)


&lt;!-- This is an auto-generated comment: release notes by coderabbit.ai
--&gt;

## Summary by CodeRabbit

- **New Features**
- Introduced a new Vim configuration for Snakemake files that enhances
comment formatting.
- Comments in Snakemake scripts will now automatically begin with a hash
symbol followed by a space for better readability.

&lt;!-- end of auto-generated comment: release notes by coderabbit.ai --&gt;
diff --git a/misc/vim/ftplugin/snakemake/comment.vim b/misc/vim/ftplugin/snakemake/comment.vim
@@ -0,0 +1 @@
+setlocal commentstring=#\ %s
