rehype plugin to remove content of external JavaScript `script` elements
npm install rehype-remove-external-script-content[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][funding-sponsors-badge]][funding]
[![Backers][funding-backers-badge]][funding]
[![Chat][chat-badge]][chat]
[rehype][] plugin to remove the contents of external JavaScript s.
* What is this?
* When should I use this?
* Install
* Use
* API
* unified().use(rehypeRemoveExternalScriptContent)
* Example
* Syntax
* Syntax tree
* Types
* Compatibility
* Security
* Contribute
* License
This package is a plugin that removes the contents of JavaScript s
that also have an src attribute.
Scripts are supposed to be either external (with src) or internal (with
code in them), and both is nonsensical.
You can use this plugin when you want to improve the transfer size of HTML
documents.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install rehype-remove-external-script-content
In Deno with [esm.sh][esm-sh]:
`js`
import rehypeRemoveExternalScriptContent from 'https://esm.sh/rehype-remove-external-script-content@4'
In browsers with [esm.sh][esm-sh]:
`html`
On the API:
`js
import rehypeParse from 'rehype-parse'
import rehypeRemoveExternalScriptContent from 'rehype-remove-external-script-content'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(rehypeParse)
.use(rehypeRemoveExternalScriptContent)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))
`
On the CLI:
`sh`
rehype input.html --use rehype-remove-external-script-content --output output.html
On the CLI in a config file (here a package.json):
`diff`
…
"rehype": {
"plugins": [
…
+ "rehype-remove-external-script-content",
…
]
}
…
This package exports no identifiers.
The default export is rehypeRemoveExternalScriptContent.
Remove the contents of external JavaScript
`
###### Out
`html`
HTML is parsed according to WHATWG HTML (the living standard), which is also
followed by all browsers.
The syntax tree used is [hast][].
This package is fully typed with [TypeScript][].
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-external-script-content@^4,
compatible with Node.js 16.
As rehype works on HTML and improper use of HTML can open you up to a
[cross-site scripting (XSS)][xss] attack, use of rehype can also be unsafe.
Use [rehype-sanitize][rehype-sanitize] to make the tree safe.
See [contributing.md][contributing] in [rehypejs/.github][health] for wayssupport.md`][support] for ways to get help.
to get started.
See [
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[author]: https://wooorm.com
[build]: https://github.com/rehypejs/rehype-minify/actions
[build-badge]: https://github.com/rehypejs/rehype-minify/workflows/main/badge.svg
[chat]: https://github.com/rehypejs/rehype/discussions
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md
[contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md
[coverage]: https://codecov.io/github/rehypejs/rehype-minify
[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-minify.svg
[downloads]: https://www.npmjs.com/package/rehype-remove-external-script-content
[downloads-badge]: https://img.shields.io/npm/dm/rehype-remove-external-script-content.svg
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esm-sh]: https://esm.sh
[funding]: https://opencollective.com/unified
[funding-backers-badge]: https://opencollective.com/unified/backers/badge.svg
[funding-sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[hast]: https://github.com/syntax-tree/hast
[health]: https://github.com/rehypejs/.github
[license]: https://github.com/rehypejs/rehype-minify/blob/main/license
[npm]: https://docs.npmjs.com/cli/install
[rehype]: https://github.com/rehypejs/rehype
[rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize
[size]: https://bundlejs.com/?q=rehype-remove-external-script-content
[size-badge]: https://img.shields.io/bundlejs/size/rehype-remove-external-script-content
[support]: https://github.com/rehypejs/.github/blob/main/support.md
[typescript]: https://www.typescriptlang.org
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting