Long comments should wrap to new lines

[igbanam]

When typing a comment, it wraps to the same line instead of wrapping to a new line.

Screen.Recording.2024-05-20.at.23.30.02.mov

I haven't done any extra customizations to the plugin. I am on the bleeding edge of Vim 9.

[alerque]

That's somewhat surprising! And I've never seen anything like it..

I'm on NeoVIM 0.10 over here, but definitely don't have the same problem:

I'm pretty skeptical that only this plugin alone is causing such a problem, this seems like some weird plugin interaction bug.

[igbanam]

Yup! Beats me too. The closest I've come to debugging this is… for some reason, formatoptions=tcqj is not being respected.

:h fo-table says this is meant to

• t autowrap text using textwidth
• c autowrap comments using textwidth
• q enable formatting with gq
• j remove the comment character when joining lines

Doesn't look like Neovim is autowrapping comments either — peep the … that indents there. Looks to me like the line ran out of screen space

[alerque]

My formatoptions is set to tcqlr12Bj by default, but I just tried your settings (again my end is NeoVIM) and didn't see a problem.

Are you sure you don't have this issue with other file types?

[igbanam]

Holy sheet! I found it 😭😭😭

vim-ledger/ftplugin/ledger.vim

Line 23 in 7b97c87

setl formatexpr=ledger#align_formatexpr(v:lnum,v:count)

ledger#align_formatexpr is effectively ledger#align_commodity which may not be applicable to comments. Commenting out this line — the one that sets is as formatexpr — fixes the issue. We don't want to incessantly format while we type. :LedgerAlign and :LedgerAlignBuffer can do the job after the typing is done.

On comment lines, it causes the behaviour in the OP. On transaction lines it actually hangs Vim. — I'm curious to see what it does in Neovim.

How to test?

• Enter a simple transaction, like the "example" below
  • I have the payee long enough to mark textwidth
• Indent the transaction line so a comment goes to textwidth
  • …just so we can notice the hang point clealy
• Type some one or two characters afterwards`
• Notice Vim hangs
• Use <C-c> to unhang it

Example

2023-01-01 * lskdjfl skdjf lsdkjflskdjf lskdjf lsdkjf lskdjf lskdjf lksdjf lksdj
  Expenses                                         92837923 USD ; lsdkfsdlfksj-X-kjl
;                                                                              ^
;                                                                              |
;                                                                             here

[igbanam]

I just tested this out in Neovim and it doesn't seem to be a problem. The lines don't wrap, but it doesn't hang either

[igbanam]

Hold that thought…

In Neovim, g:ledger_max_width=0 (i.e. textwidth=0) — this may be the reason we don't see the problem in Neovim

[igbanam]

NVM it's the same in Vim as well. I don't know why it breaks in Vim and not in Neovim

But commenting out the formatexpr line works for me

[hseg]

Got bitten by this, as well as a couple complicating factors:

• vim-ledger doesn't know tag directives can have same-line comments, so even after commenting out the formatexpr and writing eg

  tag foo  ; description
  

  when the description gets too long, the line wraps to column 0 of the next line and doesn't insert the ; comment leader EDIT: Actually, it's unclear to me to what extent this is a problem with vim or the plugin

• The default formatprg of hledger -f - print has the nasty side effect of removing all non-transaction directives. In particular, this can't be used to format account or tag directives.

[alerque]

* The default `formatprg` of `hledger -f - print` has the nasty side effect of removing all non-transaction directives. In particular, this can't be used to format `account` or `tag` directives.

This is a separate problem and a rather unfortunate issue. We should probably either remove this default or make sure it gets set in disabled mode until hledgerorg/hledger#1127 gets addressed.

Can you open a separate issue for this please?

[hseg]

Done, sorry for the long delay.

[igbanam]

Thank you.

I checked and the problem no longer exists. There's no auto-wrap anymore. This allows me to write the comment regardless of line length, and use Vim's gq or gw for text wrapping.

[alerque]

This is not actually fixed. I think the OP's personal vim defaults just changed to not automatically wrap in this scenario, but when setting up a text width this plugin still screws up the line breaks.