Gathering detailed insights and metrics for hast-util-format
Gathering detailed insights and metrics for hast-util-format
Installations
npm install hast-util-formatDeveloper
Developer Guide
BETA
Module System
ESM
Min. Node Version
Typescript Support
Yes
Node Version
22.7.0
NPM Version
10.8.3
Statistics
4 Stars
4 Commits
8 Watching
1 Branches
10 Contributors
Updated on 23 Sept 2024
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
376,379
Last day
4%
10,019
Compared to previous day
Last week
-0.7%
53,942
Compared to previous week
Last month
59.2%
216,461
Compared to previous month
Last year
0%
376,379
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
7
Versions
hast-util-format
hast utility to format whitespace in HTML.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Compatibility
- Related
- Security
- Contribute
- License
What is this?
This package is a utility that formats whitespace in HTML. In short, it works as follows:
- collapse all existing whitespace to either a line ending or a single space
(
hast-util-minify-whitespace) - remove those spaces and line endings if they do not contribute to the document
- inject needed line endings
- indent previously collapsed line endings properly
When should I use this?
This package is useful when you want to improve the readability of an HTML
fragment as it adds insignificant but pretty whitespace between elements.
The plugin rehype-format uses this package to format HTML
at the plugin level.
The package hast-util-minify-whitespace does
the inverse.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install hast-util-format
In Deno with esm.sh:
1import {format} from 'https://esm.sh/hast-util-format@1'
In browsers with esm.sh:
1<script type="module"> 2 import {format} from 'https://esm.sh/hast-util-format@1?bundle' 3</script>
Use
Say we have the following example.html:
1<!doCTYPE HTML><html> 2 <head> 3 <title>Hello!</title> 4<meta charset=utf8> 5 </head> 6 <body><section> <p>hi there</p> 7 </section> 8 </body> 9</html>
Say we have the following example.js:
1import fs from 'node:fs/promises' 2import {format} from 'hast-util-format' 3import {fromHtml} from 'hast-util-from-html' 4import {toHtml} from 'hast-util-to-html' 5 6const document = await fs.readFile('example.html', 'utf8') 7 8const tree = fromHtml(document) 9 10format(tree) 11 12const result = toHtml(tree) 13 14console.log(result)
…now running node example.js yields:
1<!doctype html> 2<html> 3 <head> 4 <title>Hello!</title> 5 <meta charset="utf8"> 6 </head> 7 <body> 8 <section> 9 <p>hi there</p> 10 </section> 11 </body> 12</html>
👉 Note: some of the changes have been made by
hast-util-to-html.
API
Options
Configuration.
Fields
blanks?(Array<string> | null | undefined) — list of tag names to join with a blank line (default:[]); these tags, when next to each other, are joined by a blank line (\n\n); for example, when['head', 'body']is given, a blank line is added between these twoindent?(string | number | null | undefined) — indentation per level (default:2); whennumber, uses that amount of spaces; whenstring, uses that per indentation levelindentInitial?(boolean | null | undefined) — whether to indent the first level (default:true); this is usually the<html>, thus not indentingheadandbody
format(tree, options)
Format whitespace in HTML.
Parameters
tree(Root) — treeoptions?(Options | null | undefined) — configuration (optional)
Returns
Nothing (undefined).
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, hast-util-format@1,
compatible with Node.js 16.
Related
hast-util-minify-whitespace— minify whitespace between elements
Security
This package is safe.
Contribute
See contributing.md in syntax-tree/.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
No vulnerabilities found.
No security vulnerabilities found.