retext-emoji
retext plugin to support emoji (❤️), gemoji (:heart:), and emoticons (<3).
Contents
What is this?
This package is a unified (retext) plugin to classify emoji (❤️), gemoji (:heart:), and emoticons (<3) as a specific node, and to optionally transform them from one type to another.
When should I use this?
You can either use this plugin any time there are emoji, gemoji, or emoticons in prose that are (incorrectly) warned about by linting plugins, or you can use it to transform them.
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:
npm install retext-emoji
In Deno with esm.sh:
import retextEmoji from 'https://esm.sh/retext-emoji@8'
In browsers with esm.sh:
<script type="module">
import retextEmoji from 'https://esm.sh/retext-emoji@8?bundle'
</script>
Use
import retext from 'retext'
import emoji from 'retext-emoji'
const file = await retext()
.use(emoji, {convert: 'encode'})
.process('I’m going to bed. :zzz:')
console.log(String(file))
Yields:
I’m going to bed. 💤
API
This package exports no identifiers. The default export is retextEmoji.
unified().use(retextEmoji[, options])
Support emoji (❤️), gemoji (:heart:), and emoticons (<3).
options
Configuration (optional).
options.convert
If, and how to convert ('encode' or 'decode', optional).
When encode is given, converts gemoji and emoticons to their unicode equivalent (:heart: and <3 to ❤️).
When decode is given, converts unicode emoji and emoticons to their gemoji equivalent (❤️ and <3 to :heart:).
Data
retext-emoji supports every gemoji and every emoticon.
Syntax tree
This plugin applies several nlcst utilities to build the AST. See their readmes for the node types supported in the tree:
nlcst-emoticon-modifier— emoticonsnlcst-emoji-modifier— emoji and gemoji
Types
This package is fully typed with TypeScript. It exports the additional type Options.
It also registers the node types with @types/nlcst. If you’re working with the syntax tree, make sure to import this plugin somewhere in your types, as that registers the new node types in the tree.
/**
* @typedef {import('retext-emoji')}
*/
import {visit} from 'unist-util-visit'
/** @type {import('nlcst').Root} */
const tree = getNlcstNodeSomeHow()
visit(tree, (node) => {
// `node` can now be `Emoticon`.
})
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.
Contribute
See contributing.md in retextjs/.github for ways to get started. See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.