nlcst-emoji-modifier

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[nlcst][] utility to classify emoji and gemoji shortcodes as EmoticonNodes.

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* emojiModifier(node)
* Types
* Compatibility
* Related
* Contribute
* License

What is this?

This utility searches for emoji (👍) and gemoji shortcodes (:+1:) and turns
them into separate nodes.

When should I use this?

This package is a tiny utility that helps when dealing with emoji and gemoji in
natural language.
The plugin [retext-emoji][retext-emoji] wraps this utility and others at a
higher-level (easier) abstraction.

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh
npm install nlcst-emoji-modifier
`

In Deno with [esm.sh][esmsh]:

`js
import {emojiModifier} from 'https://esm.sh/nlcst-emoji-modifier@6'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

`js
import {emojiModifier} from 'nlcst-emoji-modifier'
import {ParseEnglish} from 'parse-english'
import {inspect} from 'unist-util-inspect'

const english = new ParseEnglish()
english.tokenizeSentencePlugins.unshift(emojiModifier)

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

Yields:

`txt
RootNode[1] (1:1-1:32, 0-31)
└─ ParagraphNode[1] (1:1-1:32, 0-31)
└─ SentenceNode[11] (1:1-1:32, 0-31)
├─ WordNode[3] (1:1-1:5, 0-4)
│ ├─ TextNode: "It" (1:1-1:3, 0-2)
│ ├─ PunctuationNode: "’" (1:3-1:4, 2-3)
│ └─ TextNode: "s" (1:4-1:5, 3-4)
├─ WhiteSpaceNode: " " (1:5-1:6, 4-5)
├─ WordNode[1] (1:6-1:13, 5-12)
│ └─ TextNode: "raining" (1:6-1:13, 5-12)
├─ WhiteSpaceNode: " " (1:13-1:14, 12-13)
├─ EmoticonNode: ":cat:" (1:14-1:19, 13-18)
├─ WordNode[1] (1:19-1:20, 18-19)
│ └─ TextNode: "s" (1:19-1:20, 18-19)
├─ WhiteSpaceNode: " " (1:20-1:21, 19-20)
├─ WordNode[1] (1:21-1:24, 20-23)
│ └─ TextNode: "and" (1:21-1:24, 20-23)
├─ WhiteSpaceNode: " " (1:24-1:25, 23-24)
├─ EmoticonNode: ":dog:" (1:25-1:30, 24-29)
└─ WordNode[2] (1:30-1:32, 29-31)
├─ TextNode: "s" (1:30-1:31, 29-30)
└─ PunctuationNode: "." (1:31-1:32, 30-31)
`

API

This package exports the identifier [emojiModifier][api-emoji-modifier].
There is no default export.

$3

Classify emoji (👍) and Gemoji (GitHub emoji, :+1:) in node as Emoticons.

See [Emoticon in nlcst-emoticon-modifier][emoticon-mofifier-emoticon].

###### Parameters

* node ([Sentence][sentence])
— sentence to transform

###### Returns

Nothing (undefined).

Types

This package is fully typed with [TypeScript][].
It exports no additional types

See [Emoticon in nlcst-emoticon-modifier][emoticon-mofifier-emoticon] on
how to register it in TypeScript.

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, nlcst-emoji-modifier@^6,
compatible with Node.js 16.

Related

* nlcst-affix-emoticon-modifier
— merge affix emoticons into the previous sentence in nlcst
* nlcst-emoticon-modifier
— support emoticons

Contribute

See [contributing.md][contributing] in [syntax-tree/.github][health] for
ways to get started.
See [support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/syntax-tree/nlcst-emoji-modifier/workflows/main/badge.svg

[build]: https://github.com/syntax-tree/nlcst-emoji-modifier/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/nlcst-emoji-modifier.svg

[coverage]: https://codecov.io/github/syntax-tree/nlcst-emoji-modifier

[downloads-badge]: https://img.shields.io/npm/dm/nlcst-emoji-modifier.svg

[downloads]: https://www.npmjs.com/package/nlcst-emoji-modifier

[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=nlcst-emoji-modifier

[size]: https://bundlejs.com/?q=nlcst-emoji-modifier

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/syntax-tree/unist/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[license]: license

[author]: https://wooorm.com

[health]: https://github.com/syntax-tree/.github

[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md

[support]: https://github.com/syntax-tree/.github/blob/main/support.md

[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md

[retext-emoji]: https://github.com/retextjs/retext-emoji

[nlcst]: https://github.com/syntax-tree/nlcst

[sentence]: https://github.com/syntax-tree/nlcst#sentence

[emoticon-mofifier-emoticon]: https://github.com/syntax-tree/nlcst-emoticon-modifier#emoticon

[api-emoji-modifier]: #emojimodifiernode