retext-emoji

retext plugin to support emoji (❤️), gemoji (:heart:), and emoticons (<3).

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(retextEmoji[, options])
  • Options
• Data
• Syntax tree
• Types
• Compatibility
• Contribute
• License

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 16+), install with npm:

npm install retext-emoji

In Deno with esm.sh:

import retextEmoji from 'https://esm.sh/retext-emoji@9'

In browsers with esm.sh:

<script type="module">
  import retextEmoji from 'https://esm.sh/retext-emoji@9?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])

Plugin to support emoji (❤️), gemoji (:heart:), and emoticons (<3).

Parameters

• options (Options, optional) — configuration

Returns

Transform (Transformer).

Options

Configuration (TypeScript type).

Fields

• convert ('encode' or 'decode', optional) — whether to decode (❤️ and <3 to :heart:), encode (:heart: and <3 to ❤️), or do nothing

Data

retext-emoji supports every emoticon and gemoji.

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 — emoticons
• nlcst-emoji-modifier — emoji and gemoji

Types

This package is fully typed with TypeScript. It exports the additional type Options.

The Emoticon node is exposed from nlcst-emoticon-modifier.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, retext-emoji@^9, compatible with Node.js 16.

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.

License

MIT © Titus Wormer