cz-conventional-changelog-for-shortcut v7.2.5

cz-conventional-changelog-for-shortcut

Part of the commitizen family. Prompts for conventional changelog standard and also prompts for a mandatory Shortcut story.

Features

• Works seamlessly with semantic-release 🚀
• Works seamlessly with Shortcut smart commits
• Automatically detects the Shortcut story from the branch name

Quickstart

Installation

npm install commitizen cz-conventional-changelog-for-shortcut

and then add the following to package.json:

{
  "scripts": {
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog-for-shortcut"
    }
  }
}

Usage

Configuration

Like commitizen, you can specify the configuration of cz-conventional-changelog-for-shortcut through the package.json's config.commitizen key, or with environment variables.

Dynamic Configuration

Alternatively, if you want to create your own profile, you can use the configurable approach. Here is an example: ./index.js

const custom = require('cz-conventional-changelog-for-shortcut/configurable');
// You can do this optionally if you want to extend the commit types
const defaultTypes = require('cz-conventional-changelog-for-shortcut/types');

module.exports = custom({
  types: {
    ...defaultTypes,
    perf: {
      description: 'Improvements that will make your code perform better',
      title: 'Performance'
    }
  },
  skipScope: false,
  scopes: ['myScope1', 'myScope2']
});

./package.json

{
  "config": {
    "commitizen": {
      "path": "./index.js"
    }
  }
}

This example would:

• Display "perf" as an extra commit type
• Ask you to add a commit scope
• Limit the scope selection to either myScope or myScope2

List of all supported configurable options when using the configurable approach: | Key | Default | Description | | -------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | shortcutMode | true | If this is set to true, CZ will ask for a Shortcut story and put it in the commit head. If set to false CZ will ask for the issue in the end, and can be used for GitHub. | | maxHeaderWidth | 72 | This limits how long a commit message head can be. | | minHeaderWidth | 2 | This limits how short a commit message can be. | | maxLineWidth | 100 | Commit message bodies are automatically wrapped. This decides how long the lines will be. | | skipScope | true | If scope should be used in commit messages. | | defaultType | undefined | The default type. | | defaultScope | undefined | The default scope. | | defaultSubject | undefined | A default subject. | | defaultBody | undefined | A default body. | | defaultIssues | undefined | A default issue. | | shortcutPrefix | 'sc' | The default Shortcut ticket prefix that will be displayed. | | types | ./types.js | A list (JS Object) of supported commit types. | | scopes | undefined | A list (JS Array) of scopes that will be available for selection. Note that adding this will change the scope field from Inquirer 'input' to 'list'. | | shortcutOptional | false | If this is set to true, you can leave the Shortcut field blank. | | shortcutLocation | "pre-description" | Changes position of Shortcut ID. Options: pre-type, pre-description, post-description | | shortcutPrepend | "" | Prepends Shortcut ID with an optional decorator. e.g.: [sc-1234 | | shortcutAppend | "" | Appends Shortcut ID with an optional decorator. e.g.: sc-1234] |

Commitlint

If using the commitlint js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 72. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.