unist-util-inspect

unist utility to inspect trees.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • inspect(tree[, options])
  • inspectColor(tree[, options])
  • inspectNoColor(tree[, options])
  • Options
• Types
• Compatibility
• Contribute
• License

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 only. In Node.js (version 16+), install with npm:

npm install unist-util-inspect

In Deno with esm.sh:

import {inspect} from 'https://esm.sh/unist-util-inspect@8'

In browsers with esm.sh:

<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 identifiers inspect, inspectColor, and inspectNoColor. There is no default export.

inspect(tree[, options])

Inspect a tree, with color in Node, without color in browsers.

Parameters

• tree (Node) — tree to inspect
• options (Options, optional) — configuration

Returns

Pretty printed tree (string).

inspectColor(tree[, options])

🪦 Deprecated: use color option of inspect.

Inspect a tree, with color. Otherwise same as inspect.

inspectNoColor(tree[, options])

🪦 Deprecated: use color option of inspect.

Inspect a tree, without color. Otherwise same as inspect.

Options

Configuration (TypeScript type).

Fields

• color (boolean, default: true in Node, false otherwise) — whether to use ANSI colors
• showPositions (boolean, default: true) — whether to include positional information

Types

This package is fully typed with TypeScript. It exports the additional type 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

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