Danger JS Plugin - danger-plugin-kirinus

danger-plugin-kirinus

Set of Danger rules used to check Kirinus Digital PRs.

Usage

Install:

yarn add danger-plugin-kirinus --dev

At a glance:

// dangerfile.js
import kirinus from 'danger-plugin-kirinus';

(async function dangerReport() {
  const commitlintConfig = {
    severity: 'warn',
  };
  await kirinus();
})();

To override some default parameters:

// dangerfile.js
import configLernaScopes from '@commitlint/config-lerna-scopes';
import kirinus from 'danger-plugin-kirinus';

(async function dangerReport() {
  await kirinus({
    branchSize: {
      maxCommits: 20,
      maxFiles: 200,
      severity: 'fail',
    },
    conventional: {
      rules: configLernaScopes.rules,
      severity: 'warn',
    },
    prLint: {
      severity: 'disabled',
    },
    jira: {
      severity: 'message',
    },
  });
})();

Parameters

Config Name Default Description
branchSize maxCommits 10 maximum number of commits
branchSize maxLines 2000 maximum number of line additions and deletions
branchSize maxFiles 100 maximum number of changed files
branchSize severity warn danger event type
conventional rules @commitlint/config-conventional rules conventional commit rules to lint
conventional severity fail danger event type
prLint minBodyLength warn minimum number of characters in the PR body
prLint severity fail danger event type
jira severity warn danger event type

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.