Node's Pastoral Musicians

    @kicklox/cz-conventional-changelog

    1.0.3 • Public • Published

    @kicklox/cz-conventional-changelog

    Status: npm version

    Fork of the cz-conventional-changelog from commitizen, adapted to Kicklox needs. Prompts for conventional changelog standard.

    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": {     
                "tenants": ["CORE", "TENANT 1", "TENANT 2"],
                "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.

    Keywords

    none

    Install

    npm i @kicklox/cz-conventional-changelog

    DownloadsWeekly Downloads

    3

    Version

    1.0.3

    License

    ISC

    Unpacked Size

    27.2 kB

    Total Files

    7

    Last publish

    Collaborators

    • geslain
    • romainv