Error when using a type that has a dash ("-") [bug]

Expected Behavior

commitlint should accept types with dashes in them.

Current Behavior

It gives the errors “subject may not be empty” and “type may not be empty”, neither of which is true.

Affected packages

• cli
• core
• prompt
• config-angular

Steps to Reproduce (for bugs)

echo "vim-patch: the type is not empty" | npx commitlint --config commitlint.config.js

returns

⧗   input: vim-patch: the type is not empty
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint 

commitlint.config.js

module.exports = { rules: { 'body-leading-blank': [1, 'always'], 'body-max-line-length': [2, 'always', 100], 'footer-leading-blank': [1, 'always'], 'footer-max-line-length': [2, 'always', 100], 'header-max-length': [2, 'always', 100], 'scope-case': [2, 'always', 'lower-case'], 'subject-case': [ 2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case'], ], 'subject-empty': [2, 'never'], 'subject-full-stop': [2, 'never', '.'], 'type-case': [2, 'always', 'lower-case'], 'type-empty': [2, 'never'], 'type-enum': [ 2, 'always', [ 'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'test', 'vim-patch', ], ], }, };

Context

I contribute to the neovim project. We would like to introduce a type called vim-patch since many of our automation scripts depend on the commits having exactly that string.

Your Environment

Executable	Version
commitlint --version	@commitlint/cli@13.1.0, @commitlint/cli@7.6.1
git --version	2.32.0
node --version	v16.5.0

[AdeAttwood]

@dundargoc happy to hear that Neovim is using commitlint in their CI. Not so happy to here you are having issues. The issue is that the header fails to parse, we are looking for any word at the start of the commit. You can override this to look for anything that is not a (, ) or : in the parserOpts.headerPattern. An example config is below, hope this fixes the issue for you.

commitlint.config.js

module.exports = {
  parserPreset: {
    parserOpts: { headerPattern: /^([^\(\):]*)(?:\((.*)\))?!?: (.*)$/ }
  },
  rules: {
    "body-leading-blank": [1, "always"],
    "body-max-line-length": [2, "always", 100],
    "footer-leading-blank": [1, "always"],
    "footer-max-line-length": [2, "always", 100],
    "header-max-length": [2, "always", 100],
    "scope-case": [2, "always", "lower-case"],
    "subject-case": [
      2,
      "never",
      ["sentence-case", "start-case", "pascal-case", "upper-case"]
    ],
    "subject-empty": [2, "never"],
    "subject-full-stop": [2, "never", "."],
    "type-case": [2, "always", "lower-case"],
    "type-empty": [2, "never"],
    "type-enum": [
      2,
      "always",
      [
        "build",
        "chore",
        "ci",
        "docs",
        "feat",
        "fix",
        "perf",
        "refactor",
        "revert",
        "test",
        "vim-patch"
      ]
    ]
  }
};

There are a few other issues around the same thing that we are looking to fix. This will take a bit of time to get the fix in, tested and released, so you can use the above config in the short term.

Ref: #2674, #880, #1221

[AdeAttwood]

Yea please 👍