Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IonicaBizau/emojic
:joy: Emoji in your Node.js command line apps.
https://github.com/IonicaBizau/emojic
hacktoberfest
Last synced: 3 months ago
JSON representation
:joy: Emoji in your Node.js command line apps.
- Host: GitHub
- URL: https://github.com/IonicaBizau/emojic
- Owner: IonicaBizau
- License: mit
- Created: 2015-11-23T15:07:06.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-03-06T17:28:10.000Z (over 2 years ago)
- Last Synced: 2024-07-19T14:36:55.326Z (4 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 28.3 KB
- Stars: 103
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - emojic
README
[](#)
# emojic
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/emojic) [](https://www.npmjs.com/package/emojic) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> 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
```sh
# Using npm
npm install --save emojic
# Using yarn
yarn add emojic
```
## :clipboard: Example
```js
// 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());
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :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](http://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][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Thanks! :heart:
## :cake: Thanks
Thanks to [**@muan**](https://github.com/muan) for creating the [`emojilib`](https://github.com/muan/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:
- `contentful-cli`
- `emoji-logger`
- `@vtex/toolbelt-message-renderer`
- `@lightjs/cli`
- `xrpcli`
- `gsv`
- `mp3-stamp`
- `dhxer.sl-cli`
- `scrapy-chan`
- `cryptotracker`
- `clipix`
- `light-testing-serverless-temp`
- `react-library-generator`
- `badou`
- `mon-service`
- `node-charcoal`
- `xrpmon`
- `dynogen`
- `light-test-netlify`
- `@epsidev/dionisio-cli`
- `dumb-client`
- `hubbub_community`
- `@codhek/cf-cli`
- `tailwind-storybook`
- `@kushki/kushki-cli`
- `commandline-tool-shlomi-01`
- `advent-of-code-client`
- `viewar-cli`
- `react-native-gem`
- `lazybee-cli`
- `@andresmorelos/sam`
- `voila-cmd`
- `dhxer-cli`
- `omneedia`
- `ntbk`
- `harvest-cli`
- `community-hubbub`
- `dkaframework`
- `push-to-start`
- `@wymaze/cm_common_library`
- `inquirer-level-select`
- `create-one-app`
- `@viewar/cli`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW