conventional-changelog
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/conventional-changelog package

    3.1.24 • Public • Published

    NPM version Build Status Dependency Status Coverage Status

    Generate a changelog from git metadata

    Usage

    You most likely only need to use this module if you're building a library that provides an abstraction on top of conventional commits, See Getting started if you're an end-user.

    $ npm install --save conventional-changelog
    var conventionalChangelog = require('conventional-changelog');
     
    conventionalChangelog({
      preset: 'angular'
    })
      .pipe(process.stdout); // or any writable stream

    Or if you want to use your own custom preset:

    var conventionalChangelog = require('conventional-changelog');
     
    var config = require('@org/conventional-changelog-custom-preset');
    conventionalChangelog({config})
      .pipe(process.stdout); // or any writable stream

    API

    conventionalChangelog([options, [context, [gitRawCommitsOpts, [parserOpts, [writerOpts]]]]])

    Returns a readable stream.

    options

    See the conventional-changelog-core docs. The API is the same with the following changes or additions:

    preset

    Type: string Possible values: 'angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint'

    It's recommended to use a preset so you don't have to define everything yourself. Presets are names of built-in config.

    A scoped preset package such as @scope/conventional-changelog-custom-preset can be used by passing @scope/custom-preset to this option.

    NOTE: options.config will be overwritten by the values of preset. You should use either preset or config, but not both.

    Notes for parent modules

    License

    MIT

    Install

    npm i conventional-changelog

    DownloadsWeekly Downloads

    550,855

    Version

    3.1.24

    License

    MIT

    Unpacked Size

    38.4 kB

    Total Files

    5

    Last publish

    Collaborators

    • oss-bot
    • bcoe
    • andytjoslin
    • stevemao
    • marionebl
    • tapppi