rehype-normalize-attribute-value-case
rehype plugin to normalize casing of attribute values.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Example
- Syntax
- Syntax tree
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package is a plugin that normalizes the casing of certain attribute values, which optimizes for repetition-based compression (such as GZip).
When should I use this?
You can use this plugin when you want to improve the transfer size of HTML documents.
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install rehype-normalize-attribute-value-case
In Deno with esm.sh:
import rehypeNormalizeAttributeValueCase from 'https://esm.sh/rehype-normalize-attribute-value-case@3'
In browsers with esm.sh:
<script type="module">
import rehypeNormalizeAttributeValueCase from 'https://esm.sh/rehype-normalize-attribute-value-case@3?bundle'
</script>
Use
On the API:
import {read} from 'to-vfile'
import {unified} from 'unified'
import rehypeParse from 'rehype-parse'
import rehypeStringify from 'rehype-stringify'
import rehypeNormalizeAttributeValueCase from 'rehype-normalize-attribute-value-case'
main()
async function main() {
const file = await unified()
.use(rehypeParse)
.use(rehypeNormalizeAttributeValueCase)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))
}
On the CLI:
rehype input.html --use rehype-normalize-attribute-value-case --output output.html
On the CLI in a config file (here a package.json):
…
"rehype": {
"plugins": [
…
+ "rehype-normalize-attribute-value-case",
…
]
}
…
API
This package exports no identifiers. The default export is rehypeNormalizeAttributeValueCase.
unified().use(rehypeNormalizeAttributeValueCase)
Normalize casing of attributes. There are no options.
Example
In
<form method="GET"></form>
Out
<form method="get"></form>
Syntax
HTML is handled according to WHATWG HTML (the living standard), which is also followed by browsers such as Chrome and Firefox.
Syntax tree
The syntax tree format used is hast.
Types
This package is fully typed with TypeScript.
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
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.