- #2574
- #2575
- #2582

BREAKING CHANGE: minimum node version is 12

This new rule behaves similarly to the existing `signed-off-by` rule,
but introduces what would otherwise be breaking changes to the parser in
order to resolve some issues.

Rather than attempting to parse the trailers manually, this rule will
use Git's `interpret-trailers` subcommand to parse trailers according to
Git's rules. This allows us to properly detect all valid trailers, and
does not require that the trailer to search for be the last line of the
commit message (as is required by the `signed-off-by` rule).

One downside to this approach is that Git will not detect trailers if
they are grouped alongside other trailers with whitespace in the token
(e.g. `BREAKING CHANGE`). Projects that wish to use this rule may use
`BREAKING-CHANGE`, which is synonymous with `BREAKING CHANGE` but is
considered a valid trailer.

Co-authored-by: Ade Attwood <code@adeattwood.co.uk>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Fix typo in commands of example usage

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

* chore: update dependency @types/lodash to v4.14.169

* chore: fix lockfile

Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: escapedcat <github@htmlcss.de>

* fix: update dependency chalk to v4.1.1

* chore: fix lockfile

Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: escapedcat <github@htmlcss.de>

* fix: update dependency yargs to v17.0.1

* chore: fix lockfile

Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: escapedcat <github@htmlcss.de>

* chore: update dependency commitizen to v4.2.4

* chore: fix lockfile

Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: escapedcat <github@htmlcss.de>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>

)

When using the conventional commit feature of an `!` in the commit
subject the angular config get really confused and gives some error
messages that do not relate to the issue due to the message failing at
the parse stage. This overrides the angular parser preset to add in
the exclamation mark then uses the new rule to give a better error
message.

The result is with the message "fix!: the fix" previously the error
message would be "subject may not be empty" now the error message is
"subject must not have an exclamation mark in the subject to identify
a breaking change". This message it more descriptive and will give the
user info they need to resolve the issue.

This also updates the docs to highlight the difference in angular and
conventional configs, and point them in the direction of the
conventional config if they want to use the `!` in the commit messages

* chore: update dependency @types/yargs to v17

* fix(cli): refactor types to fix when yargs arguments is a Promise

I a update to the "yargs" types they added a `Promise` to the `Args`
interface. The main cli did not handle this type and failed type
checking. Now the main will handle a `Promise` by resolving it into
the `CliFlags` interface that is expected.

Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: Ade Attwood <code@adeattwood.co.uk>