conventional-changelog/commitlint

Body mistaken for footer with issue reference

Chiusa

#3364 aperta il 4 set 2022

Vedi su GitHubGuida contributor
 (0 commenti) (4 reazioni) (0 assegnatari)TypeScript (896 fork)batch import
bughelp wanted

Metriche repository

Star
 (15.497 stelle)
Metriche merge PR
 (Merge medio 12h 56m) (52 PR mergiate in 30 g)

Descrizione

Expected Behavior

Commit message:

fix: test

This is a very long line with at least one hundred characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters #32

rule: "body-max-line-length": [2, "always", "Infinity"],

The second paragraph should be interpreted as the body and therefore throw no error.

Current Behavior

The second paragraph is interpreted as the footer (because of the issue reference) and therefore footer rules are applied.

⧗   input: fix: test

This is a very long line with at least one hundred characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters #32
✖   footer's lines must not be longer than 100 characters [footer-max-line-length]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

Steps to Reproduce (for bugs)

  1. Create commit with above message
  2. Run commitlint --verbose --from=HEAD~1
  3. See error

Context

Your Environment

Executable Version
commitlint --version 17.1.2
git --version 2.27.0.windows.1
node --version 16.13.0

Guida contributor

Direzione di ricerca
Investigate the commit message parser in commitlint, specifically how it distinguishes between body and footer sections. The issue occurs because a line with an issue reference (#32) at the end is treated as a footer. Look at the 'conventional commits parser' library, especially the regex that identifies footers. The maintainers may need to adjust the parser to allow body lines containing issue references without triggering footer detection. Check the '@commitlint/parse' module and the parsing logic in the conventional commits parser package.
Tech stack
typescriptnodejs
Dominio
toolingclideveloper experience
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
conventional commitscommitlint basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45