1.2.8 โข Published 1 month ago
@localazy/conventional-changelog-preset v1.2.8
๐ฆ @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.