unist-util-inspect

unist utility to inspect nodes

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
unist-util-inspect
2418.0.0a year ago9 years agoMinified + gzip package size for unist-util-inspect in KB

Readme

unist-util-inspect
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
unist 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.shesmsh:
import {inspect} from 'https://esm.sh/unist-util-inspect@8'

In browsers with esm.shesmsh:
<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 inspectapi-inspect, inspectColorapi-inspectcolor, and inspectNoColorapi-inspectnocolor. There is no default export.

inspect(tree[, options])

Inspect a tree, with color in Node, without color in browsers.
Parameters
— tree to inspect
— configuration
Returns
Pretty printed tree (string).

inspectColor(tree[, options])

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

inspectNoColor(tree[, options])

Inspect a tree, without color. Otherwise same as inspectapi-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 Optionsapi-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.mdcontributing in syntax-tree/.githubhealth for ways to get started. See support.mdsupport 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.

License

MITlicense © Titus Wormerauthor