input is not displayed correctly (non-existing blank lines added) · conventional-changelog/commitlint#3129

(9 评论) (1 反应) (0 负责人)TypeScript (15,497 star) (896 fork)batch import

bughelp wanted

描述

Current Behavior

When there's no blank line between body and footer (and the line is recognised as footer due to existing issue reference), commitlint wrongly displays the input and adds that blank line between them, which makes the lint messages pretty confusing (please look at the example below).

Expected Behavior

Displayed input should be exactly the same as provided input.

Affected packages

cli
core
prompt
config-angular

Possible Solution

Display the initial input with no modification at all.

Steps to Reproduce (for bugs)

❯ echo "test(general): test

some body
related to #1

Issues: #2" | npx commitlint

⧗   input: test(general): test

some body

related to #1

Issues: #2
✖   footer must have leading blank line [footer-leading-blank]

(looking at what is displayed - the blank line is there, but it's actually missing)

Context

Your Environment

Executable	Version
`commitlint --version`	@commitlint/cli@16.2.3
`git --version`	git version 2.32.0 (Apple Git-132)
`node --version`	v17.9.0

贡献者指南

技术栈: typescriptnodejs
领域: cli
议题类型: bug
难度: 2
预计时间: 1-3 hours
活动状态: fresh
清晰度: clear
前置要求: basic TypeScriptunderstanding of commitlint CLI usagefamiliarity with git commit message format
新手友好度: 65
研究方向: Investigate the @commitlint/cli package to find where the commit message input is processed and displayed. The bug likely occurs in the input formatting logic, possibly in the read or format functions. Look for where the message is split into lines and reassembled, as the issue shows an extra blank line being inserted. Check files like `cli/src/read.ts` or similar. Focus on preserving the original input string without modifications.