@kei-g/emojify
TypeScript icon, indicating that this package has built-in type declarations

1.1.18 • Public • Published

Emojify licence npm

coverage dependency maintenance quality

emojify - a text formatter for :emoji: style

CI Status

Workflow Name Status
Build GitHub CI (Build)
CodeQL GitHub CI (CodeQL)
Coverage GitHub CI (Coverage)

Installation

npm i @kei-g/emojify -g

Usage

To format emojis simply, then you'll see Hello world 🎉,

echo :star: Hello world :tada: | emojify

And to see available emojis list,

emojify -l

emojify with git

To see emojified git logs,

mkdir play-with-emojify
cd play-with-emojify
git init
touch .gitkeep
git add .
git commit -m ":tada: Initial commit"
git log --color | emojify

To configure git to use emojify as pager; for example, on 🐧 linux,

git config --global core.pager 'emojify | less -R'

TODO

  • features
    • customizable dictionary of emojis
    • provide a method for escaped colons
  • quality
    • coverage
      • failure cases of parsing emojis' dictionary

License

The scripts and documentation in this project are released under the BSD-3-Clause License

Contributions

Contributions are welcome! See Contributor's Guide

Code of Conduct

👏 Be nice. See our code of conduct

Dependencies (0)

    Dev Dependencies (15)

    Package Sidebar

    Install

    npm i @kei-g/emojify

    Weekly Downloads

    1

    Version

    1.1.18

    License

    BSD-3-Clause

    Unpacked Size

    66 kB

    Total Files

    10

    Last publish

    Collaborators

    • kei-g