Skip to content
This repository has been archived by the owner on Jul 3, 2021. It is now read-only.

fz6m/individual-emoji-commit

Repository files navigation

Individual emoji commit

Using emoji to highly customize commit message.

Language: English | 简体中文

Feature

  • Automatically identify commit type and use the best Emoji

  • Support defining your favorite Emoji for different commit types

Preview

Usage

Three ways to trigger the addition of Emoji.

  • Click icon: click git panel navigation icon (🌸)

  • Keyboard: ctrl/cmd + shift + i

  • Command: Individual Emoji 🌈: insert emoji to commit message

Config

random mode

Each commit uses a random Emoji

individualEmoji.random.enable

  • default: false

individualEmoji.random.list

  • default: ['🍓', '🍉', '🍇', '🍒', '🍡', '🍥', '🍩', '🍰', '🍭', '🌸', '🌈']

example:

{
  "individualEmoji.random.enable": true,
  "individualEmoji.specified.enable": false, // using random mode needs to turn off specified mode
  "individualEmoji.random.list": ["🧀", "🍫", "🍪"]
}

specified mode

individualEmoji.specified.enable

  • default: true

individualEmoji.specified.typeConfig

  • default: Best practices of gitmoji
// https://gitmoji.dev/
[
  ['feat', ['✨']],
  ['chore', ['🔥']],
  ['fix', ['🐛']],
  ['style', ['🎨']],
  ['pref', ['⚡️']],
  ['docs', ['📝']],
  ['build', ['🚀']],
  ['test', ['✅']],
  ['release', ['🔖']],
  ['wip', ['🚧']],
  ['revert', ['⏪️']],
  ['refactor', ['♻️']],
  ['merge', ['🔀']],
]

example:

{
  "individualEmoji.specified.enable": true,
  "individualEmoji.specified.typeConfig": [
    // override default this type config ['feat', ['✨']]
    ["feat", ["🌸", "🌈"]],
    // random from individualemoji.random.list
    ["fix"],
    // not use random emoji
    ["chore", "🍎"]
  ]
}

individualEmoji.pos

  • default: start
    # start
    feat(scope): some text => feat(scope) 🌈: some text

    # end
    feat: some text => feat: some text 🌈

About

Using emoji to highly customize commit message / 使用 emoji 高度自定义你的 commit message 🌸

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks