emojic

emojic

Emoji in your Node.js command line apps.

In the screenshot below I'm using a Linux terminal emulator which doesn't support colorful emoji (in the way like OS X does).

:cloud: Installation

$ npm i --save emojic

:clipboard: Example

// Dependencies
const emojic = require("emojic")
    , colorIt = require("color-it")
    ;

console.log(emojic.x + " Something went wrong");
// => ❌ Something went wrong

console.log(emojic.whiteCheckMark + " Success");
// => ✅ Success

// If you want to color the things a little bit
// ...using color-it (you can find it on github.com/IonicaBizau/node-color-it)
console.log(" " + colorIt(emojic.x).red() + " " + colorIt("Some red error appeared").redBg());
console.log(" " + colorIt(emojic.smiley).green() + " " + colorIt("I am a happy man!").greenBg().wetAsphalt());
// Note: On Linux, ANSI styles will be used to color the output (see the screenshot)
// => ❌ Some red error appeared
// => 😃 I am a happy man

console.log(" " + colorIt(emojic.thumbsUp).green() + " " + colorIt("Thumbs up!").greenBg().wetAsphalt());
console.log(" " + colorIt(emojic.thumbsDown).green() + " " + colorIt("Thumbs down!").yellow());

:memo: Documentation

Require the library using var emojic = require("emojic"). Then you can use the camel case notation for the emoji names (like in the example). Visit emoji.muan.co to search the icons. For example, if you want to display in console :heart_eyes: (:heart_eyes:), you will use console.log(emojic.heartEyes) (notice the camelCaseStyle)

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:moneybag: Donations

Another way to support the development of my open-source modules is to set up a recurring donation, via Patreon. :rocket:

PayPal donations are appreciated too! Each dollar helps.

Thanks! :heart:

:cake: Thanks

Thanks to @muan for creating the emojilib project we use here. :sparkles:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• emoji-logger—Logging library based on flat colors and Emoji.
• ntbk (by Michael Lee)—A simple command-line journaling tool.

:scroll: License

MIT © Ionică Bizău