conventional-changelog/commitlint

Body mistaken for footer with issue reference

Open

#3,364 创建于 2022年9月4日

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

描述

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

贡献者指南

技术栈
typescriptnodejs
领域
toolingclideveloper experience
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
conventional commitscommitlint basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
45
研究方向
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.