feat: remove overflow warning

[gbprod]

This PR removes the detection of lines not following the 50/72 rule.

After a lot of discussions and thinking, I've decided that this rule should not be bundled with the tree-sitter parser.

Main reasons are:

• This is annoying for users who don't follow this rule and it's not easy to disable it ;
• This is more the job of a linter like gitlint or commitlint or query;
• This is not a syntax rule, but a convention rule
• I prefer to keep the parser as simple as possible
• After merging this PR, it will be easy to recreate this behavior using a query:

((subject) @comment.error
  (#vim-match? @comment.error ".\{50,}")
  (#offset! @comment.error 0 50 0 0))

((message_line) @comment.error
  (#vim-match? @comment.error ".\{72,}")
  (#offset! @comment.error 0 72 0 0))

References:

• Detect Git commit summaries not following the 50/72 rule #46
• https://www.reddit.com/r/neovim/comments/1cm5zir/question_should_i_commit_summaries_not_following/

[Flimm]

Even though I miss the old behaviour, I agree with this decision. I think your reasoning is sound. Thank you for introducing me to gitlint! For the lurkers, in order to ensure gitlint checks that the title line does not exceed 50 characters, add these lines to your .gitlint configuration file:

[title-max-length]
line-length=50

[cameronr]

((subject) @comment.error
  (#vim-match? @comment.error ".\{50,}")
  (#offset! @comment.error 0 50 0 0))

((message_line) @comment.error
  (#vim-match? @comment.error ".\{72,}")
  (#offset! @comment.error 0 72 0 0))

Could you share how to use the above? I can paste it into :EditQuery but it doesn't seem to highlight anything. I liked the previous behavior and am interested in reproducing it.

Thanks!

[gbprod]

You should use :TSEditQueryUserAfter highlight gitcommit and add :

;; extends

((subject) @comment.error
  (#vim-match? @comment.error ".\{50,}")
  (#offset! @comment.error 0 50 0 0))

((message_line) @comment.error
  (#vim-match? @comment.error ".\{72,}")
  (#offset! @comment.error 0 72 0 0))

[cameronr]

Thanks for the quick response. Unfortunately, I still must be missing something :( I added the above (saved and quit) but i'm still not seeing any highlighting. This is what I see when i run git commit and type in a subject and message line that are too long:

Any help is greatly appreciated!

[gbprod]

What's your highlight for @comment.error? Can you share the result of hi @comment.error?
What's your color scheme?

[cameronr]

@comment.error is a red color:

:hi @comment.error
@comment.error xxx guifg=#db4b4b

I'm using folke/tokyonight with the night style. Trying other color schemes in a live preview doesn't highlight the error either. This is on nvim 0.10.1 on macOS if that's relevant.

[cameronr]

Figured it out, it's highlights not highlight, so command should be:

:TSEditQueryUserAfter highlights gitcommit

Thanks for the help!

[nickjj]

Hi,

I really miss this behavior, the PR mentions it's easy to add it back individually with:

((subject) @comment.error
  (#vim-match? @comment.error ".\{50,}")
  (#offset! @comment.error 0 50 0 0))

((message_line) @comment.error
  (#vim-match? @comment.error ".\{72,}")
  (#offset! @comment.error 0 72 0 0))

But where would this go to have it always applied and not have to think about it?

I ran :TSEditQueryUserAfter highlights gitcommit and pasted in the snippet. It produced the file in ~/.config/nvim/after/queries/gitcommit/highlights.scm but when I type in a git commit message it doesn't show a difference for characters after 50 chars. If I put a syntax error into the file on purpose and restart Neovim it doesn't show it so I'm not sure if the file is being picked up.

Edit, it's working: Ok that's fun, the original PR message does NOT include ;; extends. I'm new to this whole ecosystem but that line made all of the difference. I thought ; were comments so I didn't think ;; had special meaning (it does).

hi @comment.error produces @comment.errorxxx guifg=#c53b53. I'm using Tokyonight Moon. The error color is a variant of red and would be easy to spot. I have spelling typos the same color and I can see them. If I run set ft in the git commit buffer it does come up as gitcommit.

I'm using LazyVim if it helps.

This is what my current Treesitter plugin config looks like:

return {
  {
    "nvim-treesitter/nvim-treesitter",
    opts = function(_, opts)
      -- Add custom treesitters not present by default in LazyVim.
      vim.list_extend(opts.ensure_installed, {
        "csv",
        "dockerfile",
        "go",
        "helm",
        "liquid",
        "nginx",
        "ruby",
        "terraform",
        "toml",
      })
    end,
  },

[gbprod]

I think you did the right thing. Maybe you can adds gitcommit in the ensure_installed list (or use this extra : https://www.lazyvim.org/extras/lang/git)

; extends is required at the begining of the file.

If it stills not work, can your share an :InspectTree result ?