Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
unist-util-inspect
Advanced tools
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.
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));
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.
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.
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.
unist utility to inspect trees.
This is a utility pretty prints the tree.
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.
This package is ESM only. In Node.js (version 16+), 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@8?bundle'
</script>
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"
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.
Pretty printed tree
(string
).
inspectColor(tree[, options])
🪦 Deprecated: use
color
option ofinspect
.
Inspect a tree, with color.
Otherwise same as inspect
.
inspectNoColor(tree[, options])
🪦 Deprecated: use
color
option ofinspect
.
Inspect a tree, without color.
Otherwise same as inspect
.
Options
Configuration (TypeScript type).
color
(boolean
, default: true
in Node, false
otherwise)
— whether to use ANSI colorsshowPositions
(boolean
, default: true
)
— whether to include positional informationThis package is fully typed with TypeScript.
It exports the additional type Options
.
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.
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.
FAQs
unist utility to inspect nodes
The npm package unist-util-inspect receives a total of 315,644 weekly downloads. As such, unist-util-inspect popularity was classified as popular.
We found that unist-util-inspect demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.