unified

Project: syntax-tree/nlcst-affix-emoticon-modifier

Package: nlcst-affix-emoticon-modifier@2.1.0

  1. Dependents: 0
  2. nlcst utility to merge affix emoticons into the previous sentence
  1. util 147
  2. utility 143
  3. unist 131
  4. nlcst 14
  5. nlcst-util 9
  6. emoticon 4

nlcst-affix-emoticon-modifier

Build Coverage Downloads Size Sponsors Backers Chat

nlcst utility to move initial emoticons into the previous sentence.

Contents

What is this?

This utility searches emoticon nodes (from nlcst-emoticon-modifier and nlcst-emoji-modifier) that start a sentence and then moves them into the previous sentence.

When should I use this?

This package is a tiny utility that helps when dealing with emoticons in natural language. It’s useful because many people place an emoticon or emoji, representing emotion related to the previous sentence, after a terminal marker. πŸ˜’

The plugin retext-emoji wraps this utility and others at a higher-level (easier) abstraction.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with npm:

npm install nlcst-affix-emoticon-modifier

In Deno with esm.sh:

import {affixEmoticonModifier} from "https://esm.sh/nlcst-affix-emoticon-modifier@2"

In browsers with esm.sh:

<script type="module">
  import {affixEmoticonModifier} from "https://esm.sh/nlcst-affix-emoticon-modifier@2?bundle"
</script>

Use

import {affixEmoticonModifier} from 'nlcst-affix-emoticon-modifier'
import {emoticonModifier} from 'nlcst-emoticon-modifier'
import {inspect} from 'unist-util-inspect'
import {ParseEnglish} from 'parse-english'

const english = new ParseEnglish()

english.useFirst('tokenizeSentence', emoticonModifier)
english.useFirst('tokenizeParagraph', affixEmoticonModifier)

console.log(inspect(english.parse('Hey. :) How is it going?')))

Yields:

RootNode[1] (1:1-1:25, 0-24)
└─0 ParagraphNode[3] (1:1-1:25, 0-24)
    β”œβ”€0 SentenceNode[4] (1:1-1:8, 0-7)
    β”‚   β”œβ”€0 WordNode[1] (1:1-1:4, 0-3)
    β”‚   β”‚   └─0 TextNode "Hey" (1:1-1:4, 0-3)
    β”‚   β”œβ”€1 PunctuationNode "." (1:4-1:5, 3-4)
    β”‚   β”œβ”€2 WhiteSpaceNode " " (1:5-1:6, 4-5)
    β”‚   └─3 EmoticonNode ":)" (1:6-1:8, 5-7)
    β”œβ”€1 WhiteSpaceNode " " (1:8-1:9, 7-8)
    └─2 SentenceNode[8] (1:9-1:25, 8-24)
        β”œβ”€0 WordNode[1] (1:9-1:12, 8-11)
        β”‚   └─0 TextNode "How" (1:9-1:12, 8-11)
        β”œβ”€1 WhiteSpaceNode " " (1:12-1:13, 11-12)
        β”œβ”€2 WordNode[1] (1:13-1:15, 12-14)
        β”‚   └─0 TextNode "is" (1:13-1:15, 12-14)
        β”œβ”€3 WhiteSpaceNode " " (1:15-1:16, 14-15)
        β”œβ”€4 WordNode[1] (1:16-1:18, 15-17)
        β”‚   └─0 TextNode "it" (1:16-1:18, 15-17)
        β”œβ”€5 WhiteSpaceNode " " (1:18-1:19, 17-18)
        β”œβ”€6 WordNode[1] (1:19-1:24, 18-23)
        β”‚   └─0 TextNode "going" (1:19-1:24, 18-23)
        └─7 PunctuationNode "?" (1:24-1:25, 23-24)

API

This package exports the identifier affixEmoticonModifier. There is no default export.

affixEmoticonModifier(paragraph)

Merge affix emoticons (EmoticonNode) in node (Paragraph).

Types

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

It also registers the Emoticon node type with @types/nlcst. If you’re working with the syntax tree, make sure to import this utility somewhere in your types, as that registers the new node types in the tree.

/**
 * @typedef {import('nlcst-affix-emoticon-modifier')}
 */

import {visit} from 'unist-util-visit'

/** @type {import('nlcst').Root} */
const tree = getNodeSomeHow()

visit(tree, (node) => {
  // `node` can now be a `Emoticon` node.
})

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 syntax-tree/.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