npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

remark-squeeze-paragraphs

v6.0.0

Published

remark plugin to remove empty paragraphs

Downloads

5,329,931

Readme

remark-squeeze-paragraphs

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to remove empty (or white space only) paragraphs.

Contents

What is this?

This package is a unified (remark) plugin 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?

This project is mostly useful when you’re using other plugins that remove things from the AST (such as remark-strip-badges). You can then use this plugin afterwards to clean stray empty paragraphs.

👉 Note: this plugin used to be useful, but with time the responsibility for cleaning the tree has shifted to the plugins that cause that.

If you need this, you should also open an issue with the tools causing that.

Install

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

npm install remark-squeeze-paragraphs

In Deno with esm.sh:

import remarkSqueezeParagraphs from 'https://esm.sh/remark-squeeze-paragraphs@6'

In browsers with esm.sh:

<script type="module">
  import remarkSqueezeParagraphs from 'https://esm.sh/remark-squeeze-paragraphs@6?bundle'
</script>

Use

import {remark} from 'remark'
import remarkSqueezeParagraphs from 'remark-squeeze-paragraphs'
import remarkStripBadges from 'remark-strip-badges'

console.log(
  String(
    await remark()
      .use(remarkStripBadges)
      .process('![](https://img.shields.io/)\n\ntext')
  )
)
// => '\n\ntext\n'

console.log(
  String(
    await remark()
      .use(remarkStripBadges)
      .use(remarkSqueezeParagraphs)
      .process('![](https://img.shields.io/)\n\ntext')
  )
)
// => 'text\n'

API

This package exports no identifiers. The default export is remarkSqueezeParagraphs.

unified().use(remarkSqueezeParagraphs)

Remove empty (or white space only) paragraphs.

Parameters

There are no parameters.

Returns

Transform (Transformer).

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, remark-squeeze-paragraphs@^6, compatible with Node.js 16.

This plugin works with unified version 3+ and remark version 4+.

Security

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

Related

Contribute

See contributing.md in remarkjs/.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