conventional-changelog/commitlint

input is not displayed correctly (non-existing blank lines added)

Open

#3129 opened on Apr 20, 2022

View on GitHub
 (9 comments) (1 reaction) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import
bughelp wanted

Description

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

Contributor guide

Tech stack
typescriptnodejs
Domain
cli
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic TypeScriptunderstanding of commitlint CLI usagefamiliarity with git commit message format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.