0.0.2 • Published 2 years ago

@nois/cz-conventional-changelog v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

cz-conventional-changelog

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

Features

  • Works seamlessly with semantic-release 🚀

Quickstart

Installation

npm install commitizen @nois/cz-conventional-changelog

and then add the following to package.json:

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

Usage

TBD

Configuration

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

Environment variablepackage.jsonDefaultDescription
CZ_PROJECT_KEYprojectKeyundefinedA default project key for issue.
CZ_MAX_HEADER_WIDTHmaxHeaderWidth72This limits how long a commit message head can be.
CZ_MIN_HEADER_WIDTHminHeaderWidth2This limits how short a commit message can be.
CZ_MAX_LINE_WIDTHmaxLineWidth100Commit message bodies are automatically wrapped. This decides how long the lines will be.
CZ_SKIP_SCOPEskipScopetrueIf scope should be used in commit messages.
scopesundefinedA 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'.
CZ_TYPEdefaultTypeundefinedThe default type.
CZ_SCOPEdefaultScopeundefinedThe default scope.
CZ_CUSTOM_SCOPEcustomScopefalseWhether user can provide custom scope in addition to predefined ones
CZ_SUBJECTdefaultSubjectundefinedA default subject.
CZ_BODYdefaultBodyundefinedA default body.
CZ_ISSUESdefaultIssuesundefinedA default issue.
CZ_ISSUE_KEY_PREPENDissueKeyPrepend""Prepends ISSUE ID with an optional decorator. e.g.: [DAZ-1234
CZ_ISSUE_KEY_APPENDissueKeyAppend""Appends ISSUE ID with an optional decorator. e.g.: DAZ-1234]
CZ_EXCLAMATION_MARKexclamationMarkfalseOn breaking changes, adds an exclamation mark (!) after the scope, e.g.: type(scope)!: break stuff. When activated, reduces the effective allowed header length by 1.

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('@nois/cz-conventional-changelog/configurable');
// You can do this optionally if you want to extend the commit types
const defaultTypes = require('@nois/cz-conventional-changelog/types');

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

./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:

KeyDefaultDescription
projectKeytrueA default project key for issue.
maxHeaderWidth72This limits how long a commit message head can be.
minHeaderWidth2This limits how short a commit message can be.
maxLineWidth100Commit message bodies are automatically wrapped. This decides how long the lines will be.
skipScopetrueIf scope should be used in commit messages.
defaultTypeundefinedThe default type.
defaultScopeundefinedThe default scope.
defaultSubjectundefinedA default subject.
defaultBodyundefinedA default body.
defaultIssuesundefinedA default issue.
types./types.jsA list (JS Object) of supported commit types.
scopesundefinedA 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'.
customScopefalseIf this is set to true, users are given an option to provide custom scope aside the ones predefined in 'scopes' array. In this case a new option named 'custom' appears in the list and once chosen a prompt appears to provide custom scope
issueKeyPrepend""Prepends ISSUE ID with an optional decorator. e.g.: [DAZ-1234
issueKeyAppend""Appends ISSUE ID with an optional decorator. e.g.: DAZ-1234]
exclamationMarkfalseOn breaking changes, adds an exclamation mark (!) after the scope, e.g.: type(scope)!: break stuff. When activated, reduces the effective allowed header length by 1.

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.

Reference