unified

Project: syntax-tree/unist-util-inspect

Package: unist-util-inspect@6.0.0

  1. Dependencies: 0·Dependents: 12
  2. unist utility to inspect nodes
  1. util 106
  2. utility 104
  3. unist 97
  4. unist-util 24
  5. inspect 2

unist-util-inspect

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to inspect nodes.

Install

npm:

npm install unist-util-inspect

Use

var u = require('unist-builder')
var inspect = require('unist-util-inspect')

var 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

inspect(node[, options])

Inspect the given 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

string — String representing node.

inspect.<style>[.<style>…](node[, options])

Where <style> is either color or noColor.

To explicitly add or remove ANSI sequences, use inspect.color(node) or inspect.noColor(node).

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