Alexandro.Net

Version 1.0.2

@stackline/unist-util-inspect

unist utility to inspect nodes

Independent maintenance of unist-util-inspect 7.0.2. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install unist-util-inspect@npm:@stackline/unist-util-inspect@1.0.2
# Or use the scoped package name in your imports
npm install @stackline/unist-util-inspect@1.0.2

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

@stackline/unist-util-inspect

unist utility to inspect nodes.

npm version license GitHub repository Docs Reddit community

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

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

Compatibility

Item Value
Package @stackline/unist-util-inspect@1.0.2
API target unist-util-inspect@7.0.2
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?

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

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 copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

Community and Links

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

Upstream issues and maintenance review

Upstream and maintenance review

This package maintains unist-util-inspect@7.0.2 under the independent @stackline/unist-util-inspect name.

Issue triage

The queried open-issue list contained no issue entries. This does not establish that the upstream is abandoned or bug-free. No runtime bug fix is claimed for this initial maintenance release.

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. Closed entries were collected for context; this report does not claim an exhaustive historic review.

Release discipline

The source commit, passing CI and CodeQL, reviewed CI tarball hash, npm provenance, normal and aliased installs, and immutable GitHub release are checked before a release is complete. Published versions and tags are never replaced.

Release changes

Changelog

1.0.0

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.