Awesome
remark-squeeze-paragraphs
remark plugin to remove empty (or white space only) paragraphs.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
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
mdast-squeeze-paragraphs
— mdast utility with similar functionality
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