Socket
Socket
Sign inDemoInstall

@spyke/conventional-changelog-preset

Package Overview
Dependencies
4
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @spyke/conventional-changelog-preset

A preset for Conventional Changelog making output similar to Babel's changelog with emojis, fancy categories and sorting.


Version published
Maintainers
1
Install size
42.2 kB
Created

Changelog

Source

v1.0.5 (2021-01-07)

:bug: Bug Fix

  • Pass errors to Q.nfcall (74e14a4)

Readme

Source

@spyke/conventional-changelog-preset

downloads CI license

A preset for Conventional Changelog and Lerna making output similar to Babel's changelog with emojis, fancy categories and sorting.

Example output.

Sections:

  • :bug: Bug Fix
  • :memo: Documentation
  • :house: Internal
  • :rocket: New Feature
  • :running_woman: Performance
  • :nail_care: Polish
  • :leftwards_arrow_with_hook: Revert

Commit types:

  • "feat" (NewFeature)
  • "feature" (NewFeature)
  • "fix" (BugFix)
  • "polish" (Polish)
  • "refactor" (Polish)
  • "docs" (Documentation)
  • "chore" (Internal)
  • "test" (Internal)
  • "perf" (Performance)
  • "revert" (Revert)

All other commit types are ignored by default.

Installation

npm install --save-dev @spyke/conventional-changelog-preset
# or
yarn add --dev @spyke/conventional-changelog-preset

Usage

Use changelogPreset options in lerna.json:

{
    "changelogPreset": "@spyke/conventional-changelog-preset",
}

Or specify it via command line:

lerna version --conventional-commits --changelog-preset '@spyke/conventional-changelog-preset'

You can override preset options in lerna.json's changelogPreset property by using an object instead of a string. For example, to define custom commit types use full section names:

{
  "changelogPreset": {
    "name": "@spyke/conventional-changelog-preset",
    "types": [
      { "type": "addition", "section": ":rocket: New Feature" },
      ...
    ]
  }
}

License

Based on the conventional-changelog-conventionalcommits.

Licensed under the MIT License, see LICENSE for more information.

Keywords

FAQs

Last updated on 07 Jan 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc