danger-plugin-conventional-commitlint


A danger plugin to lint commit messages with commitlint

Usage

Install:

``sh
npm install --save-dev danger-plugin-conventional-commitlint
`

At a glance:

`js
// dangerfile.js
import commitlint from 'danger-plugin-conventional-commitlint';
import configConventional from '@commitlint/config-conventional';

(async function dangerReport() {
const commitlintConfig = {
severity: 'warn',
};
await commitlint(configConventional.rules, commitlintConfig);
})();
`

> Note: you must provide your own rules to the function

API

commitlint([rules], [options])

$3

#### severity

Type: String

Choices: 'fail' | 'warn' | 'message'

Default: 'fail'

Danger method to call when the commit message does not pass the linter

---

#### messageReplacer

Type:

`ts
(ruleOutcome: LintOutcome, commitMessage: string) => string;
`

Default:

`
There is a problem with the commit message > [Commit message] - [Error Messages]
`

Method to add a custom message. When not passed, a default message is shown.
Example:

`ts
const messageReplacer = (
ruleOutcome: LintOutcome,
commitMessage: string,
): string => {
const errorsDescription = ruleOutcome.errors
.map((error) =>

${error.message}

)
.join('');

return

Commit message: "${commitMessage}"

${errorsDescription}

Suffix after commit message;
};
``

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.