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

rehype-javascript-to-bottom

v4.0.1

Published

rehype plugin to move JavaScript `<script>` to `<body>`

Downloads

149

Readme

rehype-javascript-to-bottom

Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to move JavaScript <script>s to the end of the body.

Contents

What is this?

This package is a plugin that can improve performance by decreasing the time to first render.

When should I use this?

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

Install

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

npm install rehype-javascript-to-bottom

In Deno with esm.sh:

import rehypeJavaScriptToBottom from 'https://esm.sh/rehype-javascript-to-bottom@4'

In browsers with esm.sh:

<script type="module">
  import rehypeJavaScriptToBottom from 'https://esm.sh/rehype-javascript-to-bottom@4?bundle'
</script>

Use

On the API:

import rehypeJavaScriptToBottom from 'rehype-javascript-to-bottom'
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(rehypeJavaScriptToBottom)
  .use(rehypeStringify)
  .process(await read('index.html'))

console.log(String(file))

On the CLI:

rehype input.html --use rehype-javascript-to-bottom --output output.html

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

 …
 "rehype": {
   "plugins": [
     …
+    "rehype-javascript-to-bottom",
     …
   ]
 }
 …

API

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

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

Move JavaScript <script>s to the end of <body>.

Parameters
  • options (Options, optional) — configuration
Returns

Transform (Transformer).

Filter

Filter scripts that would be moved (TypeScript type).

Parameters
  • node (Element) — script element
Returns

Whether to move the script (true) or not (boolean, optional).

Options

Configuration (TypeScript type).

Fields
  • filter (Filter, optional) — filter scripts that would otherwise be moved

Example

In
<!doctype html><html><head><script src="index.js"></script></head><body></body></html>
Out
<!doctype html><html><head></head><body><script src="index.js"></script></body></html>

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-javascript-to-bottom@^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) 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