Messages with an exclamation mark after type ("feat!") fail with Angular config

Indicating breaking changes with ! after type does not work when extending Angular config, but should be possible according to Conventional Commits 1.0.0.

I’m using this project through the Github Action, which currently uses commitlint 9.0.1 under the hood.

Expected Behavior

Commit message like feat!: the message has an exclamation mark should pass the lint.

Current Behavior

Lint does not pass with the following error message:

⧗ input: feat!: the message has an exclamation mark ✖ subject may not be empty [subject-empty] ✖ type may not be empty [type-empty]

Affected packages

• cli
• core
• prompt
• config-angular

Possible Solution

A workaround is to extend config-conventional instead. .commitlintrc.yml:

extends:
  - '@commitlint/config-conventional'

Since they are different, desired rules from config-angular have to also be defined below, but they are not relevant to this bug so they have been omitted.

A proper solution would be to fix this in commitlint.

Steps to Reproduce (for bugs)

1. In the repository root create file: .commitlintrc.yml:

extends:
  - '@commitlint/config-angular'

1. Enable Github Actions with the following configuration: .github/workflows/ci.yml:

name: CI
on:
  pull_request:
  push:

jobs:
  check_commit_conventions:
    name: Check commit conventions
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Check commit conventions
        uses: wagoid/commitlint-github-action@v2
        with:
          configFile: .commitlintrc.yml
          failOnWarnings: true

1. Push a commit with an exclamation mark and check CI pipeline.

---

A commenter from another issue faced problems with the version 9.0.1 as well, although he had them with config-conventional, so it might be a separate problem.

[samsonmaconi]

@aleksator how this workaround (pubgrub-rs/pubgrub#51) allows “!” along with type like “refractor!: drop some support” ? can you please explain operation performed?

I came across the issue as well using config-angular and also config-conventional Did a lil digging, and found it’s just a regex pattern mismatch. Not a bug.

config-angular has headerPattern: /^(\w*)(?:\((.*)\))?: (.*)$/ and config-conventional has headerPattern: /^(\w*)(?:\((.*)\))?!?: (.*)$/

If there’s no match due to the introduction of a ! the commit type and scope will not be found

I needed to match fix!(170793): whats poppin son and neither would work for me. Although config-conventional allows fix(170793)!: whats poppin son or fix!: whats poppin son, it isn’t what I wanted.

This is what I used:

// commitlint.config.js

module.exports = {
  extends: [
    "@commitlint/config-angular",
    "@commitlint/parse"
  ],
  rules: {...},
  parserPreset: {
    parserOpts: {
      headerPattern: /^(\w*)!?(?:\((.*)\))?: (.*)$/,  // my custom header pattern
      headerCorrespondence: ['type', 'scope', 'subject'],
      revertPattern: /^(?:Revert|revert:)\s"?([\s\S]+?)"?\s*This reverts commit (\w*)\./i,
      revertCorrespondence: ['header', 'hash']
    }
  }
};

[lewisdaly]

I switched to using @commitlint/load as documented on the website and the issue was resolved

Thanks for the tip! I was surprised how long it took me to figure this out, but in the end, the cli.ts has a clue:

https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/cli/src/cli.ts#L199

I found this worked for me in the end:

const loadedRules = await load({
    extends: [ '@commitlint/config-conventional' ],
  })
  const opts = {
    parserOpts: loadedRules.parserPreset.parserOpts
  }
  const lintResult = await lint(title, loadedRules.rules, opts)