This package has been deprecated

Author message:

switched to @weareopensource/conventional-changelog for concistency

waos-conventional-changelog

Presentation

Prompts for conventional changelog standard, based on cz-conventional-changelog, which seems to be abandoned. For this reason, we decided to make our own package and included some PRs, switch to ES6 and add an Emoji system for some fun.

PR included :

• yinzara - feat: implement subject feedback, scope filtering, subject filtering

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Node.js (10.x) - Download & Install Node.js

Installation

Global :

npm install --global commitizen waos-conventional-changelog

Local :

npm install --global commitizen
commitizen init waos-conventional-changelog --save-dev --save-exact

Integration

We suggest to follow something like this : How to create good commit messages. Juste change cz-conventional-changelog part with waos-conventional-changelog

Configuration

package.json

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

{
// ...  default values
    "config": {
        "commitizen": {      
            "path": "./node_modules/cz-conventional-changelog",
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultType": "",
            "defaultScope": "",        
            "defaultSubject": "",
            "defaultBody": "",
            "defaultIssues": ""
        }
    }
// ...    
}

Environment variables

The following environment varibles can be used to override any default configuration or package.json based configuration.

• CZ_TYPE = defaultType
• CZ_SCOPE = defaultScope
• CZ_SUBJECT = defaultSubject
• CZ_BODY = defaultBody
• CZ_MAX_HEADER_WIDTH = maxHeaderWidth
• CZ_MAX_LINE_WIDTH = maxLineWidth

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 100. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.

Licence

Dev

Pierre