npm.io
8.1.0 • Published 2 months agoCLI

standard-changelog

Licence
MIT
Version
8.1.0
Deps
3
Size
9 kB
Vulns
0
Weekly
0
Stars
8.5K

standard-changelog

ESM-only package NPM version Node version Dependencies status Install size Build status Coverage status

An opinionated approach to CHANGELOG generation using angular commit conventions.

Install

# pnpm
pnpm add standard-changelog
# yarn
yarn add standard-changelog
# npm
npm i standard-changelog

Usage

standard-changelog

The above generates a changelog based on commits since the last semver tag that match the pattern of a "Feature", "Fix", "Performance Improvement" or "Breaking Changes".

All available command line parameters can be listed using CLI: standard-changelog --help.

JS API is also available:

import { StandardChangelog } from 'standard-changelog'

const generator = new StandardChangelog()
  .readPackage()

generator
  .writeStream()
  .pipe(process.stdout)

Documentation

For comprehensive guides, CLI options, and API reference, visit the documentation website.

License

MIT

Keywords