Mirror of favoloso/conventional-changelog-emoji
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Leonardo Ascione 515812311e
๐Ÿ”– v0.10.0
7 months ago
.vscode โ™ป๏ธ Merge linter and fixer in one command 1 year ago
__tests__ ๐Ÿ› Replace correctly arguments when linter errors are shown 7 months ago
scripts ๐Ÿ— Add automatic emojis table generation in README 1 year ago
src ๐Ÿ› Replace correctly arguments when linter errors are shown 7 months ago
.gitignore ๐Ÿ— Add coverage reporting with Codecov 1 year ago
.prettierrc ๐ŸŽ‰ Initial commit 1 year ago
.release-it.json ๐Ÿ“ฆ Increment changelog with ourself 1 year ago
.travis.yml ๐Ÿ— Add coveralls 1 year ago
CHANGELOG.md ๐Ÿ”– v0.10.0 7 months ago
LICENSE Initial commit 1 year ago
README.md ๐ŸŽจ Fix release-it section doc 7 months ago
index.js โ™ป๏ธ Refactor code structure 1 year ago
jest.config.js ๐Ÿ— Add coverage reporting with Codecov 1 year ago
package.json ๐Ÿ”– v0.10.0 7 months ago
yarn.lock Merge branch 'master' into feat-breaking-change-commit 7 months ago

README.md

@favoloso/conventional-changelog-emoji

Travis CI Coveralls npm

Conventional Changelog with Emojis support ๐ŸŽ‰

Installation

yarn add --dev @favoloso/conventional-changelog-emoji

or

npm install --save-dev @favoloso/conventional-changelog-emoji

Usage

conventional-changelog -p @favoloso/emoji -i CHANGELOG.md -s

Usage with release-it

You can use conventional-changelog plugin (v11+) with the @favoloso/emoji preset.

"release-it": {
  "plugins": {
    "@release-it/conventional-changelog": {
      "preset": "@favoloso/emoji",
      "infile": "CHANGELOG.md"
    }
  }
}

Lint (and fix) commit messages

This package provides an additional bin script emoji-commit-lint.

The scripts lints and eventually changes commit messages, from traditional conventional changelog format (i.e. feat: Add a magic feature) to corresponding emoji (i.e. โœจ Add a magic feature), checks and applies correct casing (i.e. lower-case) and many more, as configured by Linter Rules.

To use it, install husky

yarn add --dev husky

Now in your package.json add:

{
  "husky": {
    "hooks": {
      "commit-msg": "emoji-commit-lint"
    }
  }
}

Now linter will check your commits. Any commit like <type>: <msg> will be automatically transformed with related emoji. See Available Emojis to see available types.

Configuration

The package works as-is, but its behaviour may be customized with the following options.

Note: This package supports cosmiconfig to provide configuration options with favolosoEmoji module name.

  • emojis (default: {})

An object allowing you to customize conventional-changelog types used (as Available Emojis table).

You should provide an object, where the key is the type you want to edit (or add), and the value is the updated configuration. Configurations will be merged with originals if existing.

See the Custom Emoji wiki page for further details.

  • rules (default: {})

Allows to customize linter rules. See the Linter Rules wiki page for further details.

  • showEmojiPerCommit (default: false)

In the changelog, shows emoji for each commit. In the default mode (false), emojis are omitted from commits and only the heading contains them (i.e. ๐Ÿ› Bug Fixes)

  • minorForBreakingInDevelopment (default: true)

Breaking changes during development will be considered as minor instead of major bumps (see semver spec).

  1. Major version zero (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable.
  • language (default: en)

Allows to translate commits group heading in CHANGELOG.md (i.e. ๐Ÿ› Bug Fixes) and in linter messages. Languages available: en, it

Example config in package.json

{
  "favolosoEmoji": {
    "showEmojiPerCommit": false
  }
}

Available Emojis

Emoji Aliases Type Type Aliases Version Bump In Changelog? Heading Order
๐Ÿšจ breaking major โœ… ๐Ÿšจ Breaking Changes 10
โœจ ๐ŸŒŸ, ๐Ÿ’ซ, ๐ŸŒ  feat minor โœ… โœจ Features 20
๐Ÿ”’ security patch โœ… ๐Ÿ”’ Security 25
๐Ÿ›  improvement imp patch โœ… ๐Ÿ›  Improvements 30
โšก๏ธ perf performance patch โœ… โšก๏ธ Performance 35
๐Ÿ› ๐Ÿž fix patch โœ… ๐Ÿ› Bug Fixes 40
๐Ÿ“š ๐Ÿ“– docs doc patch โœ… ๐Ÿ“š Documentation 50
๐Ÿ— โš™๏ธ chore chores patch โœ… ๐Ÿ— Chore 60
โ™ป๏ธ refactor patch โ™ป๏ธ Refactoring 90
๐Ÿšฆ โœ… test patch ๐Ÿšฆ Test 90
๐ŸŽจ ๐Ÿ’„ style cleanup patch ๐ŸŽจ Style 90
๐Ÿ“ฆ build deps patch ๐Ÿ“ฆ Build 90
๐Ÿ”– release patch ๐Ÿ”– Release 90
๐Ÿšง wip patch ๐Ÿšง Wip 90