Commitlint Jira Type | Config

Default configuration for the jira-type commitlint plugin.

Configurable Rules

jira-type offers the following configurable rules. By customizing these rules, you can define which messages should be accepted and rejected.

$3

An enumeration of accepted JIRA project keys. If the project key within the message is not included, then the message is rejected. By default, the value of this setting is undefined, which means that every key is accepted.

If you want to accept PROJECTA and PROJECTB only:

~~~~JavaScript
// commitlint.config.js
module.exports = {
plugins: ['commitlint-plugin-jira-type'],
extends: ['jira-type'],
rules: {
// 2 sets the level of this rule to error.
// always means that this rule should be applied as is
// (the other value is "never", which inverts the rule)
'jira-type-project-key-enum': [2, 'always', ['PROJECTA', 'PROJECTB']]
}
}
~~~~

$3

An enumeration of accepted types. If the type within the message is not included, then the message is rejected. By default, the value of this setting is undefined, which means that every type is accepted.

If you want to accept feat and fix only:

~~~~JavaScript
// commitlint.config.js
module.exports = {
plugins: ['commitlint-plugin-jira-type'],
extends: ['jira-type'],
rules: {
// 2 sets the level of this rule to error.
// always means that this rule should be applied as is
// (the other value is "never", which inverts the rule)
'jira-type-type-enum': [2, 'always', ['feat', 'fix']]
}
}
~~~~

Further Information

Please see the README of the parent monorepo.