Have ideas to improve npm?Join in the discussion! »

    nlcst-affix-emoticon-modifier
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    nlcst-affix-emoticon-modifier

    Build Coverage Downloads Size Sponsors Backers Chat

    nlcst utility to move initial emoticons into the previous sentence. Useful because many people place an emoticon, representing emotion related to the previous sentence, after a terminal marker. 😒

    Note: You probably want to use retext-emoji.

    Install

    This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

    npm:

    npm install nlcst-affix-emoticon-modifier

    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'
    
    var 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 following identifiers: affixEmoticonModifier. There is no default export.

    affixEmoticonModifier(paragraph)

    Merge affix emoticons (EmoticonNode) into the previous sentence.

    Parameters
    paragraph

    The node to process (Paragraph).

    Related

    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

    Install

    npm i nlcst-affix-emoticon-modifier

    DownloadsWeekly Downloads

    1,835

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    9.81 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar