Detect Git commit summaries not following the 50/72 rule

[ebkalderon]

One aspect of the standard gitcommit syntax highlighting present in Vim and Neovim that I particularly love is that it includes built-in rules that follow the 50/72 rule of writing Git commit messages. That is:

1. If the commit summary extends beyond 50 characters, the syntax highlighting changes accordingly to gently warn you to shorten it, if you can.
2. If the commit message extends beyond 72 characters, the syntax highlighting warns you that GitHub will automatically truncate your message (sometimes mid-word), insert ..., and overflow the rest into the commit message body, and you should definitely shorten it if you'd like your summary to remain intact.

This is helpful for folks writing commit messages who are looking to keep them nice. For reference, an example of such assistive highlighting in Neovim (using the standard gitcommit.vim syntax) is shown below:

On the other hand, this is how tree-sitter-gitcommit (installed via nvim-treesittter on my machine) highlights the same commit message:

It'd be great if this TS parser could apply similar syntax rules as those used in Vim/Neovim to detect poorly formed commit messages as they're being written, enabling editor color schemes to highlight these malformed sections accordingly. Thanks for maintaining this great open source parser!

[gbprod]

Hey!

Thanks for your feedback, it's really interesting!

Currently, this parser change the syntax color you if the message is longer than 50 characters :

What is the colorsheme you use ?

Anyway, I really like the 50/72 rule ! I will try to implement it soon!

[ebkalderon]

That's wonderful! 🎉 I currently use tamelion/neovim-molokai as my primary color scheme.

[stevenxxiu]

Could there be some way to opt out of this? I always soft line wrap my Git commits, and never hard wrap.

Having some arbitrary line length for the subject and summary, that can't be changed, feels overly restrictive.

[EDIT] I managed to remove the warning colors with the following command, but I think some official option would be better.

vim.cmd('highlight link @comment.warning.gitcommit @spell')

[gbprod]

Hey @stevenxxiu , thanks for your feedback, I wasn't aware of this change in treesitter 😅
Otherwise, you found the good way to opt-out from this ;)

[stevenxxiu]

Thanks, but do you think you could add an option to actually configure this, instead of hard coding it? My way to opt-out seems more like a hack more than anything.