$ gnpm install unist-util-inspect
unist utility to inspect trees.
This is a utility pretty prints the tree.
This utility pretty prints the tree in a format that is made custom for unist trees, which is terser than the often verbose and repetitive JSON, to more easily spot bugs and see what’s going on in the tree.
This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:
npm install unist-util-inspect
In Deno with esm.sh
:
import {inspect} from 'https://esm.sh/unist-util-inspect@7'
In browsers with esm.sh
:
<script type="module">
import {inspect} from 'https://esm.sh/unist-util-inspect@7?bundle'
</script>
import {u} from 'unist-builder'
import {inspect} from 'unist-util-inspect'
const tree = u('root', [
u('literal', '1'),
u('parent', [
u('void', {id: 'a'}),
u('literal', '2'),
u('node', {id: 'b'}, [])
])
])
console.log(inspect(tree))
Yields:
root[2]
├─0 literal "1"
└─1 parent[3]
├─0 void
│ id: "a"
├─1 literal "2"
└─2 node[0]
id: "b"
This package exports the identifiers inspect
,
inspectColor
, and inspectNoColor
.
There is no default export.
inspect(tree[, options])
Inspect a tree, with color in Node, without color in browsers.
Pretty printed tree
(string
).
inspectColor(tree[, options])
Inspect a tree, with color.
Otherwise same as inspect
.
inspectNoColor(tree[, options])
Inspect a tree, without color.
Otherwise same as inspect
.
Options
Configuration (TypeScript type).
showPositions
(boolean
, default: true
)
— whether to include positional informationThis package is fully typed with TypeScript.
It exports the additional type Options
.
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
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.
Copyright 2013 - present © cnpmjs.org | Home |