commitlint-plugin-jira-issue-in-scope

v0.0.2

Rule requiring JIRA issue number in conventional commit scope

commitlint commitlintplugin conventional-commits

0/weekUpdated 3 years agoISCUnpacked: 2.3 KB

Published by swisscat

npm install commitlint-plugin-jira-issue-in-scope

Repository Homepage npm

JIRA Issue in Scope

JIRA Issue in Scope is a plugin extension for commitlint, which is a tool for linting commit messages.

If you want to learn more about structured and convention-driven commit messages, see conventional commits

Rules

This plugin adds the following rule:
+ jira-issue-in-scope:
+ This rule ensures that the scope is defined, and is formatted as a JIRA issue number (such as JIR-XXX)

Sample Configuration

js
module.exports = {
    extends: ['@commitlint/config-conventional'],
    plugins: ['jira-issue-in-scope'],
    rules: {
        'jira-issue-in-scope': [2, 'always']
    }
};

commitlint-plugin-jira-issue-in-scope - npm explorer