@stackr23/gitmoji-conventional-commits

add gitmojis to conventional commit messages

v3

gitMojiToCC

import {gitMojiToCC}  from '@stackr23/gitmoji-conventional-commits'
const emoji           {name: 'zap', emoji: '⚡️'}
const prefixedGitmoji = gitMojiToCC({name, emoji})
console.log(prefixedGitmoji)
// => 'perf(⚡️):'

TBD - advanced format

• [ ] use scope if added - fix(<scope>): 🐛
  • add scope to promots.gitmoji

extendGitmoji

import {extendGitmoji}  from '@stackr23/gitmoji-conventional-commits'
const extendedConfig    = extendGitmoji(GITMOJI/DATA/GITMOJI.json)

adds found cc_prefix to gitmoji objects for later usage

relation table

| commit type | prefix | gitmoji | versioning | |--------------------- |--------|------------|------------| | bug fix | fix: | :bug: | patch | | feature | feat: | :sparkles: | minor | | breaking change | fix: | :boom: | major | | chore tasks | chore: | ??? | — | | documentation | doc: | :memo: | — | | styling | style: | :lipstick: | — | | refactor | refactor: | :recycle: | — | | performance | perf: | :zap: | — | | tests | test: | :white_check_mark: | — | | without topic rel | — | favicon | — |

TBC

detailed specification of conventional-commits:
https://www.conventionalcommits.org/en/v1.0.0-beta.2/

extended type definitions are stated by angular
https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type

plugin PROPOSAL conventionalcommits - gitmoji

suffix "structural elements" with gitmojis fix(header): #33 header menu open() => fix(header): :bug: #33 header menu open()

• create git-hook
• integrations / usage
  • standalone raw parser -> extendGitmoji()
• plugin integration
  • gitmoji-cli
  • conventional-changelog
  • commitizien
  • semantic-release
  • ...

other conventional-commit tools

should be considered into compatibility specations of @stackr23/gitmoji-conventional-commits

• semantic-release
• commitlint / @commitlint/config-conventional
• conventional changelog