@spyke/conventional-changelog-preset

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

Example output.

Sections:

• 🐛 Bug Fix
• 📝 Documentation
• 🏠 Internal
• 🚀 New Feature
• 🏃‍♀️ Performance
• 💅 Polish
• ↩️ 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.