rehype-prevent-favicon-request
TypeScript icon, indicating that this package has built-in type declarations

4.0.0 • Public • Published

rehype-prevent-favicon-request

Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to prevent a network request to the favicon when there is none.

Contents

What is this?

This package is a plugin that inserts an empty favicon image, when there is none referenced, to prevent a network request.

When should I use this?

You can use this plugin when you don’t have a favicon.ico at the root of your server, and want to prevent browsers sending out a network request to find it.

This plugin increases the size of the HTML, but prevents a round trip to the server by inserting an empty favicon.

Install

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

npm install rehype-prevent-favicon-request

In Deno with esm.sh:

import rehypePreventFaviconRequest from 'https://esm.sh/rehype-prevent-favicon-request@4'

In browsers with esm.sh:

<script type="module">
  import rehypePreventFaviconRequest from 'https://esm.sh/rehype-prevent-favicon-request@4?bundle'
</script>

Use

On the API:

import rehypeParse from 'rehype-parse'
import rehypePreventFaviconRequest from 'rehype-prevent-favicon-request'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'

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

console.log(String(file))

On the CLI:

rehype input.html --use rehype-prevent-favicon-request --output output.html

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

 …
 "rehype": {
   "plugins": [
     …
+    "rehype-prevent-favicon-request",
     …
   ]
 }
 …

API

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

unified().use(rehypePreventFaviconRequest)

Prevent a network request to the favicon when there is none.

Returns

Transform (Transformer).

Example

In
<!doctype html><html><head></head><body></body></html>
Out
<!doctype html><html><head><link href="data:image/x-icon;," rel="shortcut icon" type="image/x-icon"></head><body></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-prevent-favicon-request@^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

Package Sidebar

Install

npm i rehype-prevent-favicon-request

Weekly Downloads

12

Version

4.0.0

License

MIT

Unpacked Size

9.63 kB

Total Files

6

Last publish

Collaborators

  • remcohaszing
  • wooorm
  • kmck