conventional-changelog/commitlint

fix: subject-case value set to lower-case but input is not properly formatted (prompt-cli)

Open

#3570 opened on Mar 25, 2023

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

Description

Expected Behavior

Setting subject-case value to lower-case should properly format all text to lower-case. If it moves onto the next step without properly formatting, an error should properly display.

Current Behavior

  1. When I type my subject message in all uppercase, the cli shows it being lower-cased, but when I go to the next step, the subject still displays as all upper-case
  2. There is no error that pops up that my text is not lower-case

commitlint_cli

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Steps to Reproduce

1. Set subject-case rule in `commitlint.config.js`

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'subject-case': [2, 'always', 'lower-case'],
  },
};

2. When committing, I type HELLO WORLD as my subject and move to the next stage (body), no error prompt appears that my text is not lower-case. The commit message is currently generated as `fix: HELLO WORLD` instead of `fix: hello world`

Context

No response

commitlint --version

@commitlint/cli: ^17.4.2

git --version

v2.25.1

node --version

v16.14.2

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.
2
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
commitlintCLI promptsubject case rule
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is in the commitlint prompt CLI. The user expects that when subject case rule is set to lowercase, the input should be normalized to lowercase before proceeding. The bug may be in the prompt handling code, likely in the `prompt` package under `packages/prompt/src/`. Investigate how the subject is passed between steps and ensure the case transformation occurs and is validated. Consider looking at recent commits or discussions around subject case handling.