# cz-conventional-changelog

> Commitizen adapter following the conventional-changelog format.

Latest version **3.3.0** (published 2020-08-26) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.3.0 |
| Published | 2020-08-26 |
| First published | 2015-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 7 |
| Unpacked size | 29.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 793 |
| Author | Jim Cummins |
| Maintainers | commitizen-bot, jimthedev, kentcdodds, linusu, pgoodjohn |

## Links

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

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [longest](https://npm.io/package/longest.md) ^2.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
- [conventional-commit-types](https://npm.io/package/conventional-commit-types.md) ^3.0.0

## Recent versions

- 3.3.0 (latest) — 2020-08-26
- 3.2.1 — 2020-08-24
- 3.2.0 — 2020-05-04
- 3.1.1 — 2020-05-04
- 3.1.0 — 2020-01-28
- 3.0.3 — 2020-01-28
- 3.0.2 — 2019-07-21
- 3.0.1 — 2019-07-19
- 3.0.0 — 2019-07-19
- 2.1.0 — 2017-10-27
- 2.0.0 — 2017-02-21
- 1.2.0 — 2016-08-14
- 1.1.7 — 2016-08-07
- 1.1.6 — 2016-04-21
- 1.1.5 — 2015-12-02
- … 7 more at https://npm.io/package/cz-conventional-changelog/versions

## README

# cz-conventional-changelog

[![Greenkeeper badge](https://badges.greenkeeper.io/commitizen/cz-conventional-changelog.svg)](https://greenkeeper.io/)

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)](http://npm-stat.com/charts.html?package=cz-conventional-changelog&from=2015-08-01)
[![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.

## 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": "./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"
              },
              ...
            }
        }
    }
// ...
}
```

### 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 ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.

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