Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cenk1cenk2/cz-cc
Commitizen adapter for conventional commits with reduced steps.
https://github.com/cenk1cenk2/cz-cc
Last synced: about 4 hours ago
JSON representation
Commitizen adapter for conventional commits with reduced steps.
- Host: GitHub
- URL: https://github.com/cenk1cenk2/cz-cc
- Owner: cenk1cenk2
- License: mit
- Created: 2020-07-26T15:03:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-18T04:11:07.000Z (about 1 month ago)
- Last Synced: 2024-10-19T14:03:44.755Z (about 1 month ago)
- Language: JavaScript
- Size: 5.69 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @cenk1cenk2/cz-cc
[](https://gitlab.kilic.dev/libraries/cz-cc/-/commits/master) [](https://npmjs.org/package/@cenk1cenk2/cz-cc) [](https://npmjs.org/package/@cenk1cenk2/cz-cc) [](https://npmjs.org/package/@cenk1cenk2/cz-cc) [](https://github.com/semantic-release/semantic-release)
- [Description](#description)
- [Usage](#usage)
- [Configuration](#configuration)
- [package.json](#packagejson)
- [Environment Variables](#environment-variables)
- [Commitlint](#commitlint)
## Description
This is a direct fork of [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog), while it swaps `inquirer` for `enquirer` for speed and adds autocomplete to commit types as well as reducing overall questions and making many optional.
## Usage
- Install commitizen. Either globally or in the project.
```shell
# yarn
yarn global add commitizen
# npm
npm install -g commitizen
```
- Initiate this adapter in a project. If already initiated you can add the `--force` flag to swap this adapter with the older one.
- Currently has a bit of problems with yarn workspaces do to `commitizen`.
```shell
# yarn
commitizen init @cenk1cenk2/cz-cc --yarn --dev
# npm
commitizen init @cenk1cenk2/cz-cc --dev
```
- Add git-hooks.
```json
{
"simple-git-hooks": {
"prepare-commit-msg": "[ -t 1 ] && exec < /dev/tty && git cz --hook || true"
}
}
```
- Add [commitlint](https://github.com/conventional-changelog/commitlint#readme) if desired.
## Configuration
Install the adapter by utilizing global commitizen installation.
Configuration settings are down below.
### package.json
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/@cenk1cenk2/cz-cc",
"maxHeaderWidth": 100,
"maxLineWidth": 100,
"defaultType": "",
"defaultScope": "",
"defaultSubject": "",
"defaultBody": "",
"defaultIssues": "",
"types": {
...
"feat": {
"description": "A new feature",
"title": "Features"
},
...
}
}
}
// ...
}
```
### 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](https://github.com/conventional-changelog/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 overwritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.