unified

Project: syntax-tree/mdast-util-compact

Package: mdast-util-compact@4.1.0

  1. Dependents: 0
  2. mdast utility to make a tree compact
  1. util 145
  2. utility 141
  3. unist 132
  4. mdast 86
  5. tree 44
  6. mdast-util 31
  7. node 25

mdast-util-compact

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to make trees compact by collapsing adjacent text nodes and blockquotes.

Contents

What is this?

This package is a utility that lets you make a tree, after changes, more similar to how it would be parsed.

When should I use this?

Probably never! You should try and keep your trees clean yourself.

Install

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

npm install mdast-util-compact

In Deno with esm.sh:

import {compact} from 'https://esm.sh/mdast-util-compact@4'

In browsers with esm.sh:

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

Use

import {u} from 'unist-builder'
import {compact} from 'mdast-util-compact'

const tree = u('strong', [u('text', 'alpha'), u('text', ' '), u('text', 'bravo')])

compact(tree)

console.log(tree)

Yields:

{
  type: 'strong',
  children: [ { type: 'text', value: 'alpha bravo' } ]
}

API

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

compact(tree)

Make an mdast tree compact by merging adjacent text nodes and block quotes.

Parameters
Returns

The given tree (Node).

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-util-compact does not involve hast or user content so there are no openings for cross-site scripting (XSS) attacks.

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 © Titus Wormer