conventional-changelog/commitlint

`@commitlint/prompt-cli` does not abide the rules in `commitlint.config.js`

Closed

#2,899 opened on Dec 4, 2021

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)TypeScript (896 forks)batch import
bughelp wanted

Repository metrics

Stars
 (15,497 stars)
PR merge metrics
 (Avg merge 12h 56m) (52 merged PRs in 30d)

Description

I have set 'body-leading-blank': [2, 'always'] in commitlint.config.js, but when I create a commit with body using npx commit, it does not inserts a blank line before the body. When I run npx commitlint on that commit message, it correctly raises body must have leading blank line error.

Expected Behavior

Format the message according to the rules.

Current Behavior

commitlint/prompt-cli fails to create a commit message according to the rules.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

Steps to Reproduce (for bugs)

  1. First step
  2. Second step

Context

Your Environment

Executable Version
commitlint --version 15.0.0
git --version 2.31.1
node --version 17.0.1
@commitlint/prompt-cli 15.0.0

Contributor guide

Research direction
Investigate how @commitlint/prompt cli loads and applies rules from commitlint.config.js. Compare the prompt flow with @commitlint/cli to identify where the rule 'body leading blank' is not being enforced. Check the prompt package source code, likely in packages/prompt, and trace the message formatting logic. There are no linked PRs or assignees, so focus on the issue description and repository context.
Tech stack
typescriptnodejsshell
Domain
clitooling
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Node.jsUnderstanding of commitlint configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45