@stackline/unist-util-inspect

unist utility to inspect nodes.

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/unist-util-inspect is the Stackline-maintained distribution of [email protected]. It is an independent continuation of unist-util-inspect; original authors and licenses remain credited below.

Compatibility

| Item | Value | | :--- | :--- | | Package | @stackline/[email protected] | | API target | [email protected] | | Supported Node.js | See supported framework requirements | | License | MIT | | Module type | module | | Main entry | index.js | | Types | index.d.ts | | Runtime dependencies | @types/unist |

Installation

npm install @stackline/unist-util-inspect

Preserve existing imports and plugin resolution with an npm alias:

npm install unist-util-inspect@npm:@stackline/unist-util-inspect

Usage and API reference

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 14.14+ and 16.0+), install with npm:

npm install @stackline/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>

Use

import {u} from 'unist-builder'
import {inspect} from '@stackline/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])

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).

Fields

• 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 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.

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

Credits and original authors

• Original project: unist-util-inspect.
• Titus Wormer.
• Copyright (c) 2014-2015 Titus Wormer [email protected].
• Stackline maintenance: Alexandro Paixao Marques and Stackline contributors.

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

Community and Links

• Stackline website
• GitHub projects
• npm packages
• Reddit community — r/Stackline
• Maintainer LinkedIn

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.