Github/Gitlab issue ID support (in subject)

Expected Behavior

Github/Gitlab issue ID (e.g. #123, #6778) can be added as references into subject.

Current Behavior

subject-case now only allows characters

  [
    'lower-case', // default
    'upper-case', // UPPERCASE
    'camel-case', // camelCase
    'kebab-case', // kebab-case
    'pascal-case', // PascalCase
    'sentence-case', // Sentence case
    'snake-case', // snake_case
    'start-case', // Start Case
  ]

Affected packages

• cli
• core
• prompt

Possible Solution

Add regex pattern supports to subject-case, for now, I have to disable subject-case which doesn’t make sense.

commitlint.config.js

{
  "commitlint": {
    "extends": [
      "@commitlint/config-conventional"
    ],
    "parserPreset": {
      "parserOpts": {
        "issuePrefixes": [
          "#"
        ]
      }
    },
    "rules": {
      "references-empty": [2,"never"],
      "subject-case": [0,"never"],
      "subject-empty": [2, "never"]
    }
  }
}

Context

Your Environment

Executable	Version
commitlint --version	v7.0.0
git --version	v2.15.2
node --version	v10.6.0

[therealklanni]

Being able to do this by allowing regular expressions seems like a good solution. Alternately, being able to provide a function (instead of array/string) to the value part of the config…

'some-config': [2, 'always', (commit) => validateThing(commit)]

[jdbruijn]

I’ve created a plugin commitlint-plugin-function-rules, which can be used to write functions for rule values, allowing you to use a regex to specify the allowed values, and much more. I think the issue potentially could be resolved with a function rule and a regex for the subject-case rule (named function-rules/subject-case using the plugin).

I hope this helps!