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

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

[wtho]

@jaklan Yes, #896 is purely about the implementation in footer-leading-blank.ts, although a better parsing might help with that issue as well.

[jaklan]

@escapedcat

#3120 is about some issue with footer-leading-blank rule logic used to calculate if there’s blank line before footer or not, so imho it’s completely not related.

#896 is about parsing - when we provide:

test: footer-leading-blank bug

hello
see issue #1234

we get:

  body: 'hello',
  footer: 'see issue #1234',

and for:

fix: correct minor typos in code

see the issue for details

on typos fixed.

Reviewed-by: Z
Refs #133

we get:

  body: 'see the issue for details\n\non typos fixed.\n\nReviewed-by: Z',
  footer: 'Refs #133',

So in general - that’s a problem with parser not being able to properly identify what is body, and what is footer. So also not related to the above one, but to conventional-commits-parser, and affects not the input display, but the execution of defined rules.