conventional-changelog/commitlint

Sentence-case is not work properly

Open

#3517 opened on Jan 31, 2023

View on GitHub
 (10 comments) (0 reactions) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import
discussionhelp wanted

Description

Expected Behavior

module.exports = {
  extends: ["@commitlint/config-conventional"],
  rules: {
    "subject-case": [2, "always", "sentence-case"],
    "type-enum": [
      2,
      "always",
      ["ADD", "FEAT", "FIX", "REFACTOR", "REMOVE", "TEST", "UPDATE"],
    ],
    "type-case": [2, "always", "upper-case"],
  },
};

I have commitlint.config.js like this. According the rules, my subject sentence should start with capitalized word, other words should be all lowercase.

Current Behavior

But when i try to commit with message like "FEAT: Test Commit", it accepts. It should throw an error because this sentence is not compable with sentence-case.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Steps to Reproduce

1. First step
Add this rule to your configuration: "subject-case": [2, "always", "sentence-case"]
2. Second step
Make a commit that doesn't follow the rule.

commitlint --version

@commitlint/{cli,config-conventional}^17.4.2,

git --version

v2.30

node --version

v16.5.1

Contributor guide

Tech stack
typescriptnodejsjavascript
Domain
clitoolingdeveloper 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.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic commitlint setupknowledge of rule configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate the `subject case` rule implementation in `@commitlint/rules`, specifically the `sentence case` case. The issue likely stems from the regex or comparison logic not properly enforcing that only the first word is capitalized and subsequent words are lowercase, except for proper nouns. Look at the rule's source code and test files to understand the expected behavior and identify where the logic fails. Consider modifying the pattern to ensure it matches traditional sentence case.