[feature request] Comment block editing mode

[postmodern]

When editing Ruby files, if you start a comment block, any successive newlines will automatically start with a #. I would like to have the same functionality in vim-crystal.

[bew]

Hello, I personally don't want this as the default behavior.

If you want this feature for your own setup you can enable this using the flag r & o of vim's formatoptions, see http://vimdoc.sourceforge.net/htmldoc/change.html#fo-table

[rhysd]

Since the customization is done in one line, I think adding a section to show how it can be done in documentation would be good.

[robacarp]

I'm surprised that anyone wouldn't want this as the default, but here's the way to configure vim to make comment editing behave:

autocmd BufNewFile,BufRead *.cr set formatoptions+=roj

From the :help fo-table as linked above:

r	Automatically insert the current comment leader after hitting
        <Enter> in Insert mode.
o	Automatically insert the current comment leader after hitting 'o' or
        'O' in Normal mode.
j	Where it makes sense, remove a comment leader when joining lines.  For
        example, joining:
                int i;   // the index ~
                         // in the list ~
        Becomes:
                int i;   // the index in the list ~

Thanks for a tour into a world of vim options I didn't know existed in formatoptions, bew!

[bew]

I'm surprised that anyone wouldn't want this as the default

In my case I always want normal keys o & O to add blank lines below/above the current line and only when in insert mode do I want Enter to continue a commented block for me.

This allows me to have other keybinds based on o/O/Enter to easily add many blank lines, whether I'm on a comment or not, and only when needed have another keybind to continue a comment block.

Thanks for a tour into a world of vim options I didn't know existed in formatoptions, bew!

🙃