Nascent Prototype Metaverse

    mdast-squeeze-paragraphs
    TypeScript icon, indicating that this package has built-in type declarations

    5.2.0 • Public • Published

    mdast-squeeze-paragraphs

    Build Coverage Downloads Size Sponsors Backers Chat

    mdast utility to remove empty paragraphs from a tree.

    Paragraphs are considered empty if they do not contain non-whitespace characters.

    Install

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

    npm:

    npm install mdast-squeeze-paragraphs

    Use

    import {u} from 'unist-builder'
    import {squeezeParagraphs} from 'mdast-squeeze-paragraphs'
    
    const tree = u('root', [
      u('paragraph', []),
      u('paragraph', [u('text', 'Alpha')]),
      u('paragraph', [u('text', ' ')])
    ])
    
    squeezeParagraphs(tree)
    
    console.dir(tree, {depth: null})

    Yields:

    { type: 'root',
      children:
       [ { type: 'paragraph',
           children: [ { type: 'text', value: 'Alpha' } ] } ] }

    API

    This package exports the following identifiers: squeezeParagraphs. There is no default export.

    squeezeParagraphs(tree)

    Modifies tree in-place. Returns tree.

    Security

    Use of mdast-squeeze-paragraphs does not involve hast or user content so there are no openings for cross-site scripting (XSS) attacks.

    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, organization, or community you agree to abide by its terms.

    License

    MIT © Eugene Sharygin

    Install

    npm i mdast-squeeze-paragraphs

    DownloadsWeekly Downloads

    2,324,702

    Version

    5.2.0

    License

    MIT

    Unpacked Size

    7.94 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm
    • kmck