fix(is-ignored): ignore "amend!" commits

[chalkygames123]

Description

This PR allows a commit whose subject is prefixed with "amend!" to be ignored.

Motivation and Context

git-commit supports the --fixup=[(amend|reword):]<commit> option, which creates a commit whose subject is prefixed with "amend!". commitlint should ignore this, but currently, it does not.

For more information about the --fixup=[(amend|reword):]<commit> option, please see the git-commit documentation.

Usage examples

n/a

How Has This Been Tested?

According to the contribution guide.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[escapedcat]

Is this potentially a breaking change?

[chalkygames123]

I don't think so because this PR will only widen the type of ignored commits. Users won't be forced to update their configuration for this change.

[escapedcat]

Yeah, that's always what you think till someone is opening an issue and complains that their setup is behaving differently now.
I looked at the older commits tackling other cases and those all where fixes as well. So I guess we're ok here :)

@knocte wdyt?

[knocte]

Not sure TBH, shouldn't this ignore list be a param list to a rule?

[escapedcat]

Looks like we already have this?

  /*
   * Array of functions that return true if commitlint should ignore the given message.
   * Given array is merged with predefined functions, which consist of matchers like:
   *
   * - 'Merge pull request', 'Merge X into Y' or 'Merge branch X'
   * - 'Revert X'
   * - 'v1.2.3' (ie semver matcher)
   * - 'Automatic merge X' or 'Auto-merged X into Y'
   *
   * To see full list, check https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/is-ignored/src/defaults.ts.
   * To disable those ignores and run rules always, set `defaultIgnores: false` as shown below.
   */
  ignores: [(commit) => commit === ''],
  /*
   * Whether commitlint uses the default ignore rules, see the description above.
   */
  defaultIgnores: true,
  /*
   * Custom URL to show upon failure
   */

https://commitlint.js.org/reference/configuration.html#configuration-object-example

[knocte]

So then this PR is changing the defaultIgnores?

[escapedcat]

Yes, it does

[knocte]

LGTM then

[escapedcat]

🤞

[escapedcat]

https://github.com/conventional-changelog/commitlint/releases/tag/v19.2.2