hast-util-format
Advanced tools
hast utility to format whitespace in HTML.
This package is a utility that formats whitespace in HTML. In short, it works as follows:
hast-util-minify-whitespace)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.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install hast-util-format
In Deno with esm.sh:
import {format} from 'https://esm.sh/hast-util-format@1'
In browsers with esm.sh:
<script type="module">
import {format} from 'https://esm.sh/hast-util-format@1?bundle'
</script>
Say we have the following example.html:
<!doCTYPE HTML><html>
<head>
<title>Hello!</title>
<meta charset=utf8>
</head>
<body><section> <p>hi there</p>
</section>
</body>
</html>
Say we have the following example.js:
import fs from 'node:fs/promises'
import {format} from 'hast-util-format'
import {fromHtml} from 'hast-util-from-html'
import {toHtml} from 'hast-util-to-html'
const document = await fs.readFile('example.html', 'utf8')
const tree = fromHtml(document)
format(tree)
const result = toHtml(tree)
console.log(result)
…now running node example.js yields:
<!doctype html>
<html>
<head>
<title>Hello!</title>
<meta charset="utf8">
</head>
<body>
<section>
<p>hi there</p>
</section>
</body>
</html>
👉 Note: some of the changes have been made by
hast-util-to-html.
OptionsConfiguration.
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);
when number,
uses that amount of spaces; when string,
uses that per indentation levelindentInitial? (boolean | null | undefined)
— whether to indent the first level (default: true);
this is usually the <html>,
thus not indenting head and bodyformat(tree, options)Format whitespace in HTML.
tree (Root)
— treeoptions? (Options | null | undefined)
— configuration (optional)Nothing (undefined).
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.
hast-util-minify-whitespace
— minify whitespace between elementsThis package is safe.
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.
FAQs
Format whitespace in HTML
We found that hast-util-format demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.