Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 of 4 tasks
TiagoGrosso opened this issue Dec 18, 2023 · 5 comments
Open
1 of 4 tasks

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

TiagoGrosso opened this issue Dec 18, 2023 · 5 comments

Comments

@TiagoGrosso
Copy link

TiagoGrosso commented Dec 18, 2023

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

@kajweb

This comment was marked as duplicate.

@TiagoGrosso
Copy link
Author

Just to add that this also happens with the footer, meaning that prompt will not add a line between the body and the footer

@ticmaidev

This comment was marked as off-topic.

@weixinwu
Copy link
Contributor

@escapedcat , I feel like calling forceLeadingBlankFn in the onEnd event here would work right? I will look into it a bit more and create a PR for this.

@escapedcat
Copy link
Member

@weixinwu thanks! prompt is not in a good state I believe. But sure, give it a try!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

5 participants