rehype-concat-javascript
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorsfunding-sponsors-badgefunding
!Backersfunding-backers-badgefunding
!Chatchat-badgechatrehype plugin to concatenate
<script>s together.Contents
* [`unified().use(rehypeConcatJavaScript)`](#unifieduserehypeconcatjavascript)What is this?
This package is a plugin that can improve performance by merging multiple JS<script> elements together.
This plugin can be dangerous if JavaScript is invalid or values are expected
to be undefined in one script but not in another.When should I use this?
You can use this plugin when you are certain that your JavaScript is and you want to improve the size of HTML.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install rehype-concat-javascriptIn Deno with
esm.shesm-sh:import rehypeConcatJavaScript from 'https://esm.sh/rehype-concat-javascript@4'In browsers with
esm.shesm-sh:<script type="module">
import rehypeConcatJavaScript from 'https://esm.sh/rehype-concat-javascript@4?bundle'
</script>Use
On the API:import rehypeConcatJavaScript from 'rehype-concat-javascript'
import rehypeParse from 'rehype-parse'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(rehypeParse)
.use(rehypeConcatJavaScript)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))On the CLI:
rehype input.html --use rehype-concat-javascript --output output.htmlOn the CLI in a config file (here a
package.json):…
"rehype": {
"plugins": [
…
+ "rehype-concat-javascript",
…
]
}
…API
This package exports no identifiers. The default export isrehypeConcatJavaScript.unified().use(rehypeConcatJavaScript)
Concatenate JS <script> elements together.Returns
Transform (Transformer).Example
In
<script>function foo() {}</script>
<script>function bar() {}</script>Out
<script>function foo() {};function bar() {}</script>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-concat-javascript@^4,
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)xss attack, use of rehype can also be unsafe. Userehype-sanitizerehype-sanitize to make the tree safe.Contribute
Seecontributing.mdcontributing in rehypejs/.githubhealth for ways
to get started.
See support.mdsupport for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.
