conventional-changelog/commitlint

Body mistaken for footer with issue reference

Closed

#3,364 opened on Sep 4, 2022

View on GitHubContributor guide
 (0 comments) (4 reactions) (0 assignees)TypeScript (896 forks)batch import
bughelp wanted

Repository metrics

Stars
 (15,497 stars)
PR merge metrics
 (Avg merge 12h 56m) (52 merged PRs in 30d)

Description

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

Contributor guide

Research direction
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
Domain
toolingclideveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
conventional commitscommitlint basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45