# cz-conventional-commit

> Commitizen adapter following the conventional-changelog format.

Latest version **1.0.6** (published 2019-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install cz-conventional-commit
pnpm add cz-conventional-commit
yarn add cz-conventional-commit
bun add cz-conventional-commit
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2019-11-13 |
| First published | 2019-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 7 |
| Unpacked size | 26.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Speedmonkey |
| Maintainers | speedmonkey |

## Links

- npm: https://www.npmjs.com/package/cz-conventional-commit
- Repository: https://github.com/speedmonkey/cz-conventional-commit
- Issues: https://github.com/speedmonkey/cz-conventional-commit/issues
- npm.io page: https://npm.io/package/cz-conventional-commit

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [longest](https://npm.io/package/longest.md) ^2.0.1
- [right-pad](https://npm.io/package/right-pad.md) ^1.0.1
- [word-wrap](https://npm.io/package/word-wrap.md) ^1.0.3
- [commitizen](https://npm.io/package/commitizen.md) ^4.0.3
- [lodash.map](https://npm.io/package/lodash.map.md) ^4.5.1
- [@commitlint/load](https://npm.io/package/@commitlint/load.md) >6.1.1

## Recent versions

- 1.0.6 (latest) — 2019-11-13
- 1.0.5 — 2019-11-12
- 1.0.4 — 2019-11-12
- 1.0.3 — 2019-11-12
- 1.0.2 — 2019-11-12
- 1.0.1 — 2019-11-12
- 1.0.0 — 2019-11-12

## README

# cz-conventional-commit

Status:
[![npm version](https://img.shields.io/npm/v/cz-conventional-changelog.svg?style=flat-square)](https://www.npmjs.org/package/cz-conventional-changelog)
[![npm downloads](https://img.shields.io/npm/dm/cz-conventional-changelog.svg?style=flat-square)](https://npm-stat.com/charts.html?package=cz-conventional-commit&from=2019-11-05&to=2019-11-12)
[![Build Status](https://img.shields.io/travis/commitizen/cz-conventional-changelog.svg?style=flat-square)](https://travis-ci.org/commitizen/cz-conventional-changelog)

Part of the [commitizen](https://github.com/commitizen/cz-cli) family. Prompts for [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) standard.

## How to use

### Adaptater for commitizen 

To use this package, you need to add this following to your package.json root file :

```json5
"config": {
    "commitizen": {
      "path": "cz-conventional-commit"
    },
}
```

### What's change ?

Four types of commit are now available (with emojis ): 
- fix
- feat
- style
- refactor 

![Commitizen Interface](https://user-images.githubusercontent.com/19270653/68765942-38cd8500-061e-11ea-9590-757a08806fba.png)

There are now just three steps : type, scope and short description. Example of a commit ruled by this package :

![Commitizen Steps](https://user-images.githubusercontent.com/19270653/68766642-84ccf980-061f-11ea-854c-9c64e430e520.png)


## Configuration

### 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": "cz-conventional-commit",
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultType": "",
            "defaultScope": "",        
            "defaultSubject": ""
        }
    }
// ...    
}
``` 
### 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_MAX_HEADER_WIDTH = maxHeaderWidth
* CZ_MAX_LINE_WIDTH = maxLineWidth

---
_Source: https://npm.io/package/cz-conventional-commit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._