conventional-changelog/commitlint

fix: prompt does not respect [body-leading-blank] setting

Open

#3826 opened on Dec 18, 2023

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

Description

Expected Behavior

When creating a commit with prompt, if you have body-leading-blank enabled, it should insert a line between the summary and the body

Current Behavior

When creating a commit with prompt, if you have body-leading-blank enabled, it will not insert a line between the summary and the body and will cause a warning or error (depending on your config) when validating the commit message

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Steps to Reproduce

  1. Add prompt to your project
  2. Add extends: ['@commitlint/config-angular'] to your commitlint config file (or explicltly add rules: { 'body-leading-blank': [2, 'always'] } )
  3. Run prompt (npx commit) and provide a body to your commit message
  4. Check the commit message, it will not have a line between the summary and the body
  • (Optional) Run commitlint and you'll see a warning about [body-leading-blank]

Context

No response

commitlint --version

18.4.3

git --version

2.34.1

node --version

v20.9.0

Contributor guide

Tech stack
typescriptnodejs
Domain
clideveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic commitlint usageTypeScript familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the prompt package's commit message generation logic. Look at how the prompt constructs the commit message and where it should insert a blank line between summary and body. Check the configuration for body leading blank rule. The issue is in packages/prompt/src/... Examine the buildCommit function to see if it respects the body leading blank setting. Also review any related comments in the issue for potential clues.