rehype-sort-attribute-values
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorsfunding-sponsors-badgefunding
!Backersfunding-backers-badgefunding
!Chatchat-badgechatrehype plugin to sort attribute values.
Contents
* [`unified().use(rehypeSortAttributeValues)`](#unifieduserehypesortattributevalues)What is this?
This package is a plugin that sorts 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 onlyesm. In Node.js (version 16+), install with npm:npm install rehype-sort-attribute-valuesIn Deno with
esm.shesm-sh:import rehypeSortAttributeValues from 'https://esm.sh/rehype-sort-attribute-values@5'In browsers with
esm.shesm-sh:<script type="module">
import rehypeSortAttributeValues from 'https://esm.sh/rehype-sort-attribute-values@5?bundle'
</script>Use
On the API:import rehypeParse from 'rehype-parse'
import rehypeSortAttributeValues from 'rehype-sort-attribute-values'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(rehypeParse)
.use(rehypeSortAttributeValues)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))On the CLI:
rehype input.html --use rehype-sort-attribute-values --output output.htmlOn the CLI in a config file (here a
package.json):…
"rehype": {
"plugins": [
…
+ "rehype-sort-attribute-values",
…
]
}
…API
This package exports no identifiers. The default export isrehypeSortAttributeValues.unified().use(rehypeSortAttributeValues)
Sort attribute values.Returns
Transform (Transformer).Example
In
<div class="qux quux foo bar"></div>Out
<div class="bar foo quux qux"></div>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-sort-attribute-values@^5,
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.
