rehype-minify-attribute-whitespace
rehype plugin to minify whitespace in attributes.
Contents
What is this?
This package is a plugin that can remove unneeded whitespace around the
values of certain attributes.
When should I use this?
You can use this plugin when you want to improve the size of HTML documents.
Install
This package is ESM only.
In Node.js (version 16+), install with npm:
npm install rehype-minify-attribute-whitespace
In Deno with esm.sh
:
import rehypeMinifyAttributeWhitespace from 'https://esm.sh/rehype-minify-attribute-whitespace@4'
In browsers with esm.sh
:
<script type="module">
import rehypeMinifyAttributeWhitespace from 'https://esm.sh/rehype-minify-attribute-whitespace@4?bundle'
</script>
Use
On the API:
import rehypeMinifyAttributeWhitespace from 'rehype-minify-attribute-whitespace'
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(rehypeMinifyAttributeWhitespace)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))
On the CLI:
rehype input.html --use rehype-minify-attribute-whitespace --output output.html
On the CLI in a config file (here a package.json
):
…
"rehype": {
"plugins": [
…
+ "rehype-minify-attribute-whitespace",
…
]
}
…
API
This package exports no identifiers.
The default export is rehypeMinifyAttributeWhitespace
.
unified().use(rehypeMinifyAttributeWhitespace)
Minify whitespace in attributes.
Returns
Transform (Transformer
).
Example
In
<a href=" http://example.com "></a>
Out
<a href="http://example.com"></a>
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-minify-attribute-whitespace@^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