gte

gulp-task-emoji-commit

A gulp task to easily add an emoji taken from a list in your commit message

Showing:

Popularity

Downloads/wk

1

GitHub Stars

8

Maintenance

Last Commit

7yrs ago

Contributors

0

Package

Dependencies

4

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

gulp-emoji-commit

What?

Emojis as a way to indicate commits purpose are awesome!

However, remembering the differents emojis for the different kind of commits can be tedious.

This gulp task make this process easy!

Usage

npm install gulp-task-emoji-commit

Then add this to your Gulpfile.js

var gulp = require('gulp'),
    emojiCommit = require('gulp-task-emoji-commit');

emojiCommit(gulp, {
  taskName: 'commit', // optional: falls back to "commit"
  choices: require('./emoji-choices.js'), // required
  emojiMsg: 'Choose an awesome emoji!', // optional
  commitInputMsg: 'Now enter your commit message, yo!' // optional
});

Emojis list

In this examples I use a js file as a list of emojis. You can use what you want as long as it's an array of strings formatted like this

[':racehorse: performance related'] // :emoji_shortcode: Why is this emoji so awesome?

Voilà, happy commiting! 🎉 💥

Contribute

NPM Page

Fork the repo, do your stuff, install dependencies, and open a pull request so we can make all the commits awesome!

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