# mdast-squeeze-paragraphs

> mdast utility to remove empty paragraphs from a tree

Latest version **6.0.0** (published 2023-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install mdast-squeeze-paragraphs
pnpm add mdast-squeeze-paragraphs
yarn add mdast-squeeze-paragraphs
bun add mdast-squeeze-paragraphs
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2023-07-08 |
| First published | 2015-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 2 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Eugene Sharygin |
| Maintainers | wooorm, kmck |
| Keywords | unist, mdast, mdast-util, util, utility, squeeze, remove, empty, paragraph, whitespace, tree, transform, transformation, clean |

## Links

- npm: https://www.npmjs.com/package/mdast-squeeze-paragraphs
- Repository: https://github.com/syntax-tree/mdast-squeeze-paragraphs
- Homepage: https://github.com/syntax-tree/mdast-squeeze-paragraphs#readme
- Issues: https://github.com/syntax-tree/mdast-squeeze-paragraphs/issues
- Funding: https://opencollective.com/unified
- npm.io page: https://npm.io/package/mdast-squeeze-paragraphs

## Dependencies (2)

- [@types/mdast](https://npm.io/package/@types/mdast.md) ^4.0.0
- [unist-util-visit](https://npm.io/package/unist-util-visit.md) ^5.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 6.0.0 (latest) — 2023-07-08
- 5.2.1 — 2023-01-25
- 5.2.0 — 2021-08-03
- 5.1.0 — 2021-07-30
- 5.0.0 — 2021-04-23
- 4.0.0 — 2020-02-22
- 3.0.5 — 2019-05-24
- 3.0.4 — 2018-12-05
- 3.0.3 — 2018-08-20
- 3.0.2 — 2017-06-13
- 3.0.1 — 2016-01-23
- 3.0.0 — 2016-01-04
- 1.1.0 — 2015-08-12
- 2.1.1 — 2015-07-22
- 2.1.0 — 2015-07-22
- … 2 more at https://npm.io/package/mdast-squeeze-paragraphs/versions

## README

# mdast-squeeze-paragraphs

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[mdast][] utility to remove empty paragraphs.

## Contents

*   [What is this?](#what-is-this)
*   [When should I use this?](#when-should-i-use-this)
*   [Install](#install)
*   [Use](#use)
*   [API](#api)
    *   [`squeezeParagraphs(tree)`](#squeezeparagraphstree)
*   [Types](#types)
*   [Compatibility](#compatibility)
*   [Security](#security)
*   [Related](#related)
*   [Contribute](#contribute)
*   [License](#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`][remark-squeeze-paragraphs], exists that
does the same but for [remark][].

## Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

```sh
npm install mdast-squeeze-paragraphs
```

In Deno with [`esm.sh`][esmsh]:

```js
import {squeezeParagraphs} from 'https://esm.sh/mdast-squeeze-paragraphs@6'
```

In browsers with [`esm.sh`][esmsh]:

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

## Use

```js
import {squeezeParagraphs} from 'mdast-squeeze-paragraphs'
import {u} from 'unist-builder'

const tree = u('root', [
  u('paragraph', []),
  u('paragraph', [u('text', 'Alpha')]),
  u('paragraph', [u('text', ' ')])
])

squeezeParagraphs(tree)

console.dir(tree, {depth: null})
```

Yields:

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

## API

This package exports the identifier
[`squeezeParagraphs`][api-squeezeparagraphs].
There is no default export.

### `squeezeParagraphs(tree)`

Remove empty paragraphs in `tree`.

###### Parameters

*   `tree` ([`Node`][node])
    — tree to change

###### Returns

Nothing (`undefined`).

## Types

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

## Compatibility

Projects maintained by the unified collective are compatible with maintained
versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
`mdast-squeeze-paragraphs@^6`, compatible with Node.js 16.

## Security

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

## Related

*   [`remark-squeeze-paragraphs`][remark-squeeze-paragraphs]
    — remark plugin
*   [`mdast-util-compact`](https://github.com/syntax-tree/mdast-util-compact)
    — make a tree compact

## Contribute

See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
ways to get started.
See [`support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

## License

[MIT][license] © Eugene Sharygin

<!-- Definitions -->

[build-badge]: https://github.com/syntax-tree/mdast-squeeze-paragraphs/workflows/main/badge.svg

[build]: https://github.com/syntax-tree/mdast-squeeze-paragraphs/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-squeeze-paragraphs.svg

[coverage]: https://codecov.io/github/syntax-tree/mdast-squeeze-paragraphs

[downloads-badge]: https://img.shields.io/npm/dm/mdast-squeeze-paragraphs.svg

[downloads]: https://www.npmjs.com/package/mdast-squeeze-paragraphs

[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-squeeze-paragraphs

[size]: https://bundlejs.com/?q=mdast-squeeze-paragraphs

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/syntax-tree/unist/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[license]: license

[health]: https://github.com/syntax-tree/.github

[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md

[support]: https://github.com/syntax-tree/.github/blob/main/support.md

[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md

[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

[hast]: https://github.com/syntax-tree/hast

[mdast]: https://github.com/syntax-tree/mdast

[node]: https://github.com/syntax-tree/mdast#node

[remark]: https://github.com/remarkjs/remark

[remark-squeeze-paragraphs]: https://github.com/remarkjs/remark-squeeze-paragraphs

[api-squeezeparagraphs]: #squeezeparagraphstree

---
_Source: https://npm.io/package/mdast-squeeze-paragraphs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._