nlcst-affix-emoticon-modifier
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 14.14+ and 16.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 parser = new ParseEnglish()
parser.tokenizeSentencePlugins.unshift(emoticonModifier)
parser.tokenizeParagraphPlugins.unshift(affixEmoticonModifier)
console.log(inspect(parser.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(node)
Merge emoticons in node into EmoticonNodes.
Parameters
node(Paragraph) — nlcst paragraph to transform
Returns
Nothing (void).
Emoticon
Emoticon node (TypeScript type).
See Emoticon in nlcst-emoticon-modifier.
Types
This package is fully typed with TypeScript. It exports the additional type Emoticon.
It also registers the Emoticon node type with @types/nlcst in SentenceContentMap. 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 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
Related
nlcst-emoticon-modifier— support emoticonsnlcst-emoji-modifier— support emoji and gemoji
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.