unist-util-inspect

What is unist-util-inspect?

The `unist-util-inspect` package is a utility for inspecting and visualizing the structure of Unist syntax trees. It provides a way to convert these trees into a human-readable string format, which is useful for debugging and understanding the tree structure.

What are unist-util-inspect's main functionalities?

Inspecting a Unist Tree

This feature allows you to inspect a Unist tree by converting it into a human-readable string format. The code sample demonstrates how to use the `inspect` function to visualize a simple Unist tree.

const inspect = require('unist-util-inspect');
const tree = {
  type: 'root',
  children: [
    { type: 'paragraph', children: [{ type: 'text', value: 'Hello, world!' }] }
  ]
};
console.log(inspect(tree));

Other packages similar to unist-util-inspect

unist-util-visit

The `unist-util-visit` package is used for tree traversal in Unist syntax trees. It allows you to visit nodes in a tree and perform operations on them. Unlike `unist-util-inspect`, which focuses on visualizing the tree, `unist-util-visit` is more about manipulating and traversing the tree.

unist-builder

The `unist-builder` package provides a way to create Unist syntax trees programmatically. It is useful for constructing trees from scratch, whereas `unist-util-inspect` is used for visualizing existing trees.

unist-util-map

The `unist-util-map` package allows you to transform Unist trees by applying a function to each node. This is different from `unist-util-inspect`, which is used for visualizing the tree structure rather than transforming it.

README

unist-util-inspect

Unist node inspector.

Installation

npm:

npm install unist-util-inspect

Component.js:

component install wooorm/unist-util-inspect

Bower:

bower install unist-util-inspect

Duo:

var inspect = require('wooorm/unist-util-inspect');

unist-util-inspect is also available for bower, component, duo, and for AMD, CommonJS, and globals (uncompressed and compressed).

Usage

var retext = require('retext');
var inspect = require('unist-util-inspect');

retext().use(function () {
    return function (cst) {
        console.log(inspect(cst));
    }
}).process('Some simple text.');

Yields:

RootNode[1] (1:1-1:18, 0-17)
└─ ParagraphNode[1] (1:1-1:18, 0-17)
   └─ SentenceNode[6] (1:1-1:18, 0-17)
      ├─ WordNode[1] (1:1-1:5, 0-4)
      │  └─ TextNode: "Some" (1:1-1:5, 0-4)
      ├─ WhiteSpaceNode: " " (1:5-1:6, 4-5)
      ├─ WordNode[1] (1:6-1:12, 5-11)
      │  └─ TextNode: "simple" (1:6-1:12, 5-11)
      ├─ WhiteSpaceNode: " " (1:12-1:13, 11-12)
      ├─ WordNode[1] (1:13-1:17, 12-16)
      │  └─ TextNode: "text" (1:13-1:17, 12-16)
      └─ PunctuationNode: "." (1:17-1:18, 16-17)

API

inspect(node)

By default, color support is enabled on node and turned off anywhere else. See below on how to change that.

Parameters

• node (Node).

Returns string — String representing node.

inspect.<style>[.<style>...](node)

Where style is either color or noColor.

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

License

MIT © Titus Wormer