retext-emoji

retext-emoji

Emoji, gemoji, and emoticons in retext.

Installation

npm:

npm install retext-emoji

retext-emoji is also available for bower, and duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

var retext = require('retext');
var emoji = require('retext-emoji');
var inspect = require('unist-util-inspect');

retext().use(emoji).use(function () {
    return function (node) {
        console.log(inspect(node));
    }
}).process('I’m going to bed. :zzz:');

Yields:

RootNode[1]
└─ ParagraphNode[1]
   └─ SentenceNode[10]
      ├─ WordNode[3]
      │  ├─ TextNode: 'I'
      │  ├─ PunctuationNode: '’'
      │  └─ TextNode: 'm'
      ├─ WhiteSpaceNode: ' '
      ├─ WordNode[1]
      │  └─ TextNode: 'going'
      ├─ WhiteSpaceNode: ' '
      ├─ WordNode[1]
      │  └─ TextNode: 'to'
      ├─ WhiteSpaceNode: ' '
      ├─ WordNode[1]
      │  └─ TextNode: 'bed'
      ├─ PunctuationNode: '.'
      ├─ WhiteSpaceNode: ' '
      └─ EmoticonNode: ':zzz:' [data={"names":["zzz"],"description":"sleeping symbol","tags":["sleeping"]}]

API

retext.use(emoji[, options])

Emoji, gemoji, and emoticons in retext.

Parameters

• emoji — This plug-in;

• options (Object, optional):

  • convert ("encode" or "decode", optional) — When encode, converts short-codes into their unicode equivalent (e.g., :heart: and <3 to ❤️); When decode, converts unicode emoji into their short-code equivalent (e.g., ❤️ and <3 to :heart:).

EmoticonNode

retext-emoji adds a new node to NLCST, namely, the EmoticonNode (SymbolNode).

Whether emoji (❤️), emoticon (<3), or gemoji (:heart:), all are classified as this EmoticonNode.

interface EmoticonNode < SymbolNode {
    type: "EmoticonNode";
    data: EmoticonData;
}

interface EmoticonData {
    names: [string];
    description: string | null;
    tags: [string];
}

Support

retext-emoji supports every wooorm/gemoji and every wooorm/emoticon.

License

MIT © Titus Wormer