close
The Wayback Machine - https://web.archive.org/web/20201019234628/https://github.com/eramdam/gulp-task-commit-emoji
Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

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!

Image

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!

About

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

Resources

License

Packages

No packages published
You can’t perform that action at this time.