conventional-changelog/commitlint

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

Chiusa

#3826 aperta il 18 dic 2023

Vedi su GitHubGuida contributor
 (5 commenti) (1 reazione) (0 assegnatari)TypeScript (896 fork)batch import
bughelp wanted

Metriche repository

Star
 (15.497 stelle)
Metriche merge PR
 (Merge medio 12h 56m) (52 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
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.
Tech stack
typescriptnodejs
Dominio
clideveloper experience
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
basic commitlint usageTypeScript familiarity
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
55