gch

@zerrrrrr/gitmoji-commit-hook

Start the commit message with an applicable emoji

Showing:

Popularity

Downloads/wk

1

GitHub Stars

65

Maintenance

Last Commit

3d ago

Contributors

9

Package

Dependencies

5

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Gitmoji-commit-hook

Build Status

Prepend the right emoji to your commit message from Gitmoji

Install

  • Install gitmoji-commit-hook package
$ npm install -g gitmoji-commit-hook
  • Install the hook
$ cd any-git-initialized-directory
$ gitmoji-commit-hook --init

Usage

Demo

Config

You can put unwanted emojis in a blacklist section by adding the name in a blacklist array in your package.json:

{
  "gitmoji": {
    "blacklist": [
      "card-file-box",
      "beers"
    ]
  }
}

Emoji Meanings

A list of available emojis and their associated meanings can be found at gitmoji.carloscuesta.me

KISS principle

This package follow KISS principle, the only thing it does is to allow you to add an emoji from gitmojis list to your commit.

If you're looking for some other cool feature like search in gitmojis list, please consider gitmoji-cli

Develop

To run the linter: npm run lint

To run the unit test: npm test

To dry run the script:

node invoke.js --init # run the init setup

node invoke.js mock_hooks/COMMIT_EDITMSG # simulate a git commit

License

The code is available under the MIT license.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial