Skip to content

Plugin for conventional-changelog with support for emoji commits and squashed PRs.

License

Notifications You must be signed in to change notification settings

localazy/conventional-changelog-preset

Repository files navigation

Localazy

📦 @localazy/conventional-changelog-preset

Plugin for conventional-changelog with support for emoji commits and squashed PRs.

🔧 Installation

npm i -D conventional-changelog \
conventional-changelog-cli \
conventional-recommended-bump@9 \
https://github.com/localazy/conventional-changelog-preset.git \
https://github.com/localazy/conventional-changelog-writer.git

🚀 Usage

# show cli help
npx conventional-changelog --help
# regenerate whole changelog
npx conventional-changelog -p @localazy/preset -i CHANGELOG.md -s -r 0
# add latest release to changelog
npx conventional-changelog -p @localazy/preset -i CHANGELOG.md -s -r 1
# preview unreleased changelog
npx conventional-changelog -p @localazy/preset -u
# preview recommended bump: patch|minor|major
npx conventional-recommended-bump -p @localazy/conventional-changelog-preset

🔨 Configuration

You can create .changelogrc.json file in your root folder to extend or create additional emoji groups. Look at the default configuration file for reference. Use type property as identifier when extending existing configuration.

{
  "emojis": [
    {
      "type": "feat",
      "emojiAliases": [
        "🌟",
        "💫",
        "🌠",
        "💙"
      ]
    }
  ]
}

🎉 Available Emojis

Emoji Aliases Type Type Aliases Version Bump In Changelog? Heading Order
💥 breaking major 💥 Breaking Changes 10
🌟, 💫, 🌠 feat feature minor ✨ Features 20
⚡️ perf performance patch ⚡️ Performance 30
🐛 🐞, 🚑, 🚨 fix fixes, hotfix, hotfixes patch 🐛 Bug Fixes 40
📚 📖, 📝 docs doc patch 📚 Documentation 50
🧪 ✅, 🚦 test tests patch 🧪 Tests 60
♻️ 🦄 refactor patch 🧰 Other Commits 70
💄 🎨, 🌈 style cleanup, format, lint patch 🧰 Other Commits 71
🔧 ⚙️, 🏗, ⬆️ chore chores, deps, build, ci patch 🧰 Other Commits 72
🚀 release patch 1000

📜 License

Code released under the MIT license.

About

Plugin for conventional-changelog with support for emoji commits and squashed PRs.

Resources

License

Stars

Watchers

Forks

Packages

No packages published