cz-conventional-changelog
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

cz-conventional-changelog

Commitizen adapter following the conventional-changelog format.

3.0.2  •  Updated 8 months ago  •  by commitizen  •  MIT License

Status: npm version npm downloads Build Status

Part of the commitizen family. 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": {      
            "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.

Popularity

Weekly Downloads
233.6K
Stars
316

Maintenance

Development

Last ver 8 months ago
Created 5 years ago
Last commit 8 months ago
1 month between commits

Technology

Node version: 10.16.0
28.2K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

17 contributors
Jim Cummins
Maintainer, 8 commits, 15 merges, 2 PRs
Works at SPSCommerce
Linus Unnebäck
Maintainer, 11 commits, 11 merges, 1 PRs
Works at ctrl-alt-deseat
greenkeeper[bot]
8 commits
Kent C. Dodds
Maintainer, 3 commits, 1 PRs
Works at kentcdodds
Amine Mouafik
2 commits, 1 PRs
Matt Travi
2 commits, 2 PRs
Works at GainCompliance
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.