mdast-squeeze-paragraphs

mdast-squeeze-paragraphs

mdast utility to remove empty paragraphs.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • squeezeParagraphs(tree)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a utility that removes empty paragraphs, left over from other operations, from the tree. Paragraphs are considered empty if they do not contain non-whitespace characters.

When should I use this?

Probably never! You should try to clean your trees yourself.

A plugin, remark-squeeze-paragraphs, exists that does the same but for remark.

Install

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

npm install mdast-util-squeeze-paragraphs

In Deno with esm.sh:

import {squeezeParagraphs} from 'https://esm.sh/mdast-util-squeeze-paragraphs@5'

In browsers with esm.sh:

<script type="module">
  import {squeezeParagraphs} from 'https://esm.sh/mdast-util-squeeze-paragraphs@5?bundle'
</script>

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 identifier squeezeParagraphs. There is no default export.

squeezeParagraphs(tree)

Remove empty paragraphs in tree.

Parameters

• tree (Node) — tree to change

Returns

Changed tree (Node), or null if it was an empty paragraph.

Types

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

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.

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

• remark-squeeze-paragraphs — remark plugin
• mdast-util-compact — make a tree compact

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