unist-util-inspect

unist utility to inspect trees.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • inspect(node[, options])
  • inspectColor(node[, options])
  • inspectNoColor(node[, 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 12.20+, 14.14+, 16.0+, 18.0+), 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@7?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(node[, options])

Inspect the given node (Node). By default, colors are added in Node, and not in other places. See below on how to change that.

options.showPositions

Whether to include positional information (boolean, default: true).

Returns

Pretty printed node (string).

inspectColor(node[, options])

Inspect with ANSI color sequences (default in Node, Deno).

inspectNoColor(node[, options])

Inspect without ANSI color sequences (default in browser, react-native).

Types

This package is fully typed with TypeScript. It exports the additional type Options.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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