conventional-changelog/commitlint

fix: Body line with reference like `#123` is considered footer

Open

#4,099 创建于 2024年7月10日

在 GitHub 查看
 (2 评论) (1 反应) (0 负责人)TypeScript (15,497 star) (896 fork)batch import
bughelp wanted

描述

Steps to Reproduce

echo 'rules: {footer-leading-blank: [2, always]}' > .commitlintrc.yml
cat > commit-message.txt << EOF
fix: don't frobnicate the foobar

This commit prevents the foobar from being frobnicated
during operation, and therefore fixes #69.
EOF
npx '@commitlint/cli@19.3.0' -e commit-message.txt

Current Behavior

Validation fails with:

⧗   input: fix: don't frobnicate the foobar

This commit prevents the foobar from being frobnicated

during operation, and therefore fixes #69.
✖   footer must have leading blank line [footer-leading-blank]

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

Expected Behavior

Validation passes.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Context

Also happens with the full reference format: user/repo#123

commitlint --version

@commitlint/cli@19.3.0

git --version

v2.45.2

node --version

v22.4.0

贡献者指南

技术栈
typescriptnodejs
领域
cli
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
commit message conventionscommitlint configurationNode.jsTypeScript
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
Investigate the commit message parsing logic in the @commitlint/parse package, specifically the function that separates body and footer. The current implementation treats any line starting with a reference (like #123 or user/repo#123) as footer, which is incorrect. Review the regex or conditional logic to ensure that reference lines within the body are not mistaken for footer lines. Check for existing tests or comments in the codebase related to footer detection.