rehype-remove-comments

rehype-remove-comments

rehype plugin to remove comments.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(rehypeRemoveComments[, options])
  • Options
  • Test
• Example
• Syntax
• Syntax tree
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package is a plugin that removes comments. By default it keeps conditional comments, optionally it removes them too.

When should I use this?

You can use this plugin when you want to improve the transfer size of HTML documents.

Install

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

npm install rehype-remove-comments

In Deno with esm.sh:

import rehypeRemoveComments from 'https://esm.sh/rehype-remove-comments@6'

In browsers with esm.sh:

<script type="module">
  import rehypeRemoveComments from 'https://esm.sh/rehype-remove-comments@6?bundle'
</script>

Use

On the API:

import rehypeParse from 'rehype-parse'
import rehypeRemoveComments from 'rehype-remove-comments'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'

const file = await unified()
  .use(rehypeParse)
  .use(rehypeRemoveComments)
  .use(rehypeStringify)
  .process(await read('index.html'))

console.log(String(file))

On the CLI:

rehype input.html --use rehype-remove-comments --output output.html

On the CLI in a config file (here a package.json):

 …
 "rehype": {
   "plugins": [
     …
+    "rehype-remove-comments",
     …
   ]
 }
 …

API

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

unified().use(rehypeRemoveComments[, options])

Remove comments.

Parameters

• options (Options, optional) — configuration

Returns

Transform (Transformer).

Options

Configuration (TypeScript type).

Fields

• removeConditional (boolean, default: false) — remove conditional comments (default: false); the default is to leave them
• test (Test, optional) — choose which comments to keep (optional)

Test

Test a comment (TypeScript type).

Parameters

• value (string) — comment value

Returns

Whether to keep the comment (boolean, optional).

Example

In

<!--Hello-->
<!--[if IE 6]>OK<![endif]-->

Out

<!--[if IE 6]>OK<![endif]-->

Syntax

HTML is parsed according to WHATWG HTML (the living standard), which is also followed by all browsers.

Syntax tree

The syntax tree used is hast.

Types

This package is fully typed with TypeScript.

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, rehype-remove-comments@^6, compatible with Node.js 16.

Security

As rehype works on HTML and improper use of HTML can open you up to a cross-site scripting (XSS) attack, use of rehype can also be unsafe. Use rehype-sanitize to make the tree safe.

Contribute

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