Sentence-case is not work properly · conventional-changelog/commitlint#3517

(10 留言) (0 反應) (0 負責人)TypeScript (15,497 star) (896 fork)batch import

discussionhelp wanted

描述

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

貢獻者指南

技術棧: typescriptnodejsjavascript
領域: clitoolingdeveloper experience
議題類型: bug
難度: 3
預計時間: 1-3 hours
活動狀態: active
清晰度: clear
前置要求: basic commitlint setupknowledge of rule configuration
新手友善度: 45
研究方向: 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.