# conventional-changelog-writer

> Write logs based on conventional commits and templates.

Latest version **9.2.1** (published 2026-08-10) · MIT license · 0 weekly downloads

## Install

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

Provides the command `conventional-changelog-writer`.

## Health

**Score 63/100 (C)** — status: active.

Positive: has types package; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 9.2.1 |
| Published | 2026-08-10 |
| First published | 2015-07-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/conventional-changelog-writer) |
| Module format | ESM |
| Node | >=22 |
| Dependencies | 5 |
| Unpacked size | 67.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8511 |
| Author | Steve Mao |
| Maintainers | bcoe, oss-bot, dangreen, stevemao, tapppi |
| Keywords | conventional-changelog-writer, changelog, conventional, commits, templates, writer, writing, logs |

## Links

- npm: https://www.npmjs.com/package/conventional-changelog-writer
- Repository: https://github.com/conventional-changelog/conventional-changelog
- Homepage: https://conventional-changelog.js.org/changelog-writer/
- Issues: https://github.com/conventional-changelog/conventional-changelog/issues
- npm.io page: https://npm.io/package/conventional-changelog-writer

## Dependencies (5)

- [semver](https://npm.io/package/semver.md) ^7.5.2
- [argue-cli](https://npm.io/package/argue-cli.md) ^3.1.0
- [@simple-libs/stream-utils](https://npm.io/package/@simple-libs/stream-utils.md) ^2.0.0
- [conventional-commits-filter](https://npm.io/package/conventional-commits-filter.md) ^6.0.1
- [@conventional-changelog/template](https://npm.io/package/@conventional-changelog/template.md) ^1.3.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 9.2.1 (latest) — 2026-08-10
- 4.0.18 (next) — 2020-11-05
- 9.2.0 — 2026-07-09
- 9.1.1 — 2026-07-04
- 9.1.0 — 2026-06-27
- 9.0.0 — 2026-06-26
- 8.4.0 — 2026-03-04
- 8.3.0 — 2026-03-01
- 8.2.0 — 2025-07-09
- 8.1.0 — 2025-05-19
- 8.0.1 — 2025-02-16
- 8.0.0 — 2024-05-03
- 7.0.1 — 2023-09-11
- 7.0.0 — 2023-08-27
- 6.0.1 — 2023-07-09
- … 55 more at https://npm.io/package/conventional-changelog-writer/versions

## README

# conventional-changelog-writer

[![ESM-only package][package]][package-url]
[![NPM version][npm]][npm-url]
[![Node version][node]][node-url]
[![Dependencies status][deps]][deps-url]
[![Install size][size]][size-url]
[![Build status][build]][build-url]
[![Coverage status][coverage]][coverage-url]

[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
[package-url]: https://nodejs.org/api/esm.html

[npm]: https://img.shields.io/npm/v/conventional-changelog-writer.svg
[npm-url]: https://npmjs.com/package/conventional-changelog-writer

[node]: https://img.shields.io/node/v/conventional-changelog-writer.svg
[node-url]: https://nodejs.org

[deps]: https://img.shields.io/librariesio/release/npm/conventional-changelog-writer
[deps-url]: https://libraries.io/npm/conventional-changelog-writer

[size]: https://packagephobia.com/badge?p=conventional-changelog-writer
[size-url]: https://packagephobia.com/result?p=conventional-changelog-writer

[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions

[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master

Write logs based on conventional commits and templates.

## Install

```bash
# pnpm
pnpm add conventional-changelog-writer
# yarn
yarn add conventional-changelog-writer
# npm
npm i conventional-changelog-writer
```

## Usage

```js
import { writeChangelogString } from 'conventional-changelog-writer'

// commits parsed by conventional-commits-parser
const commits = [/* ... */]
const context = {
  version: '1.0.0',
  host: 'https://github.com',
  owner: 'conventional-changelog',
  repository: 'conventional-changelog'
}

console.log(await writeChangelogString(commits, context))
/*
## 1.0.0 (2015-05-29)

### Features

* **ng-list:** Allow custom separator ([13f3160](https://github.com/...))
...
*/
```

## Documentation

For streams and async iterables helpers, context and options reference, customization guide, and CLI usage, visit the [documentation website](https://conventional-changelog.js.org/changelog-writer/).

## License

MIT © [Steve Mao](https://github.com/stevemao)

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