Commitizen adapter following the conventional-changelog format.
npm install @ryansonshine/cz-conventional-changelogA fork of [commitzen/cz-conventional-changelog][0] with latest vulnerability
fixes for publishing to npm.
This repository was created out of needing a fix for [commitizen/cz-cli#914][1].
It appears the maintainers [may no longer have access to publish][2] to npm, but
can still approve/merge bug fixes.
This package will continue to be updated in npm with changes from the upstream
repository.
``sh`
npm uninstall cz-conventional-changelog
npm install --save-dev @ryansonshine/cz-conventional-changelog
[0]:https://github.com/commitizen/cz-conventional-changelog
[1]:https://github.com/commitizen/cz-cli/issues/914
[2]:https://github.com/commitizen/cz-cli/issues/897
Status:
Part of the commitizen family. Prompts for conventional changelog standard.
Like commitizen, you specify the configuration of cz-conventional-changelog through the package.json's config.commitizen key.
`json5``
{
// ... default values
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog",
"disableScopeLowerCase": false,
"disableSubjectLowerCase": false,
"maxHeaderWidth": 100,
"maxLineWidth": 100,
"defaultType": "",
"defaultScope": "",
"defaultSubject": "",
"defaultBody": "",
"defaultIssues": "",
"types": {
...
"feat": {
"description": "A new feature",
"title": "Features"
},
...
}
}
}
// ...
}
The following environment variables 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
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.