nlcst-emoji-modifier

nlcst-emoji-modifier

NLCST modifier to classify unicode emoji and Github emoji (gemoji) short-codes as EmoticonNodes.

Implemented by retext-emoji, but separated for use by standalone (non-retext) processing.

Installation

npm:

npm install nlcst-emoji-modifier

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

Usage

var modifier = require('nlcst-emoji-modifier');
var inspect = require('unist-util-inspect');
var english = require('parse-english')();

english.useFirst('tokenizeSentence', modifier);

console.log(inspect(english.parse('It\'s raining :cat:s and :dog:s.')));

Yields:

RootNode[1]
└─ ParagraphNode[1]
   └─ SentenceNode[10]
      ├─ WordNode[1]
      │  └─ TextNode: 'Who'
      ├─ WhiteSpaceNode: ' '
      ├─ WordNode[3]
      │  ├─ TextNode: 'doesn'
      │  ├─ PunctuationNode: '’'
      │  └─ TextNode: 't'
      ├─ WhiteSpaceNode: ' '
      ├─ WordNode[1]
      │  └─ TextNode: 'like'
      ├─ WhiteSpaceNode: ' '
      ├─ WordNode[1]
      │  └─ TextNode: 'Gemoji'
      ├─ WhiteSpaceNode: ' '
      ├─ EmoticonNode: ':+1:'
      └─ PunctuationNode: '?'

API

emojiModifier(sentence)

Classify unicode emoji and Github emoji (gemoji) short-codes as EmoticonNodes.

Parameters

• sentence (NLCSTSentenceNode) — Node with children.

Throws

• Error — When not given a parent node.

Related

• nlcst;
• nlcst-emoticon-modifier;
• nlcst-affix-emoticon-modifier;
• parse-latin;
• parse-dutch;
• parse-english;
• retext.

License

MIT © Titus Wormer