unist-util-inspect
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatunist utility to inspect trees.
Contents
* [`inspect(tree[, options])`](#inspecttree-options)
* [`inspectColor(tree[, options])`](#inspectcolortree-options)
* [`inspectNoColor(tree[, options])`](#inspectnocolortree-options)
* [`Options`](#options)
What is this?
This is a utility pretty prints the tree.When should I use this?
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.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install unist-util-inspect
In Deno with
esm.sh
esmsh:import {inspect} from 'https://esm.sh/unist-util-inspect@8'
In browsers with
esm.sh
esmsh:<script type="module">
import {inspect} from 'https://esm.sh/unist-util-inspect@8?bundle'
</script>
Use
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"
API
This package exports the identifiersinspect
api-inspect,
inspectColor
api-inspectcolor, and inspectNoColor
api-inspectnocolor.
There is no default export.inspect(tree[, options])
Inspect a tree, with color in Node, without color in browsers.Parameters
— tree to inspect
options
(Options
api-options, optional)
— configuration
Returns
Pretty printedtree
(string
).inspectColor(tree[, options])
Inspect a tree, with color.
Otherwise same as inspect
api-inspect.inspectNoColor(tree[, options])
Inspect a tree, without color.
Otherwise same as inspect
api-inspect.Options
Configuration (TypeScript type).Fields
showPositions
(boolean
, default:true
)
— whether to include positional information
Types
This package is fully typed with TypeScript. It exports the additional typeOptions
api-options.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,
unist-util-inspect@^8
,
compatible with Node.js 16.Contribute
Seecontributing.md
contributing in syntax-tree/.github
health for
ways to get started.
See support.md
support 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.