Unist Tree Inspector

Common errors

• ERR_REQUIRE_ESM

  cause Attempting to use `require('unist-util-inspect')` in a CommonJS module after the package became ESM-only.
  fix Change your import statement to `import { inspect } from 'unist-util-inspect'` and ensure your project is configured for ESM, or use dynamic import `import('unist-util-inspect')`.

• Error: This module requires Node.js 16 or later.

  cause Running `unist-util-inspect` on a Node.js version older than 16.
  fix Update your Node.js environment to version 16 or newer. You can use `nvm` to manage Node.js versions easily.

• Property 'inspectColor' does not exist on type 'typeof import("unist-util-inspect")'.

  cause Using the deprecated `inspectColor` or `inspectNoColor` functions in a TypeScript project, potentially after they have been removed or type definitions have been updated.
  fix Migrate to using the `color` option with the main `inspect` function: `inspect(tree, { color: true })` for colored output and `inspect(tree, { color: false })` for uncolored output.

Warnings

• breaking Version 8.0.0 and newer require Node.js 16 or later. Running on older Node.js versions will result in an error.
  Fix: Upgrade your Node.js environment to version 16 or a newer maintained release.
• breaking The package transitioned to ESM-only with an `export` map in v8.0.0, building upon its initial ESM migration in v7.0.0. Direct CommonJS `require()` statements will fail.
  Fix: Ensure you are using `import` statements for all package imports. If your project is CommonJS, you may need to convert it to ESM or use a dynamic import `import('unist-util-inspect')`.
• deprecated The `inspectColor` and `inspectNoColor` functions are deprecated. They will be removed in a future major version.
  Fix: Replace `inspectColor(tree)` with `inspect(tree, { color: true })` and `inspectNoColor(tree)` with `inspect(tree, { color: false })`.
• breaking Version 5.0.0 introduced TypeScript types. While beneficial, this could cause breaking changes for existing TypeScript projects if type definitions conflict or are not handled correctly.
  Fix: Review type declarations and ensure compatibility with your project's TypeScript configuration. Use `import type` for type-only imports where appropriate.

Install

• npm install unist-util-inspect npm
• yarn add unist-util-inspect yarn
• pnpm add unist-util-inspect pnpm

Imports

• inspect
  wrong:

  const inspect = require('unist-util-inspect')

  correct:

  import { inspect } from 'unist-util-inspect'

  The package is ESM-only since v7.0.0. CommonJS `require()` is not supported.
• inspectColor

  import { inspectColor } from 'unist-util-inspect'

  This function is deprecated since v8.1.0. Use `inspect(tree, { color: true })` instead.
• Options

  import type { Options } from 'unist-util-inspect'

  Type-only import for configuring inspection options. Available since v5.0.0.

Quickstart

Demonstrates how to import and use the `inspect` function with a sample unist tree, showing both colored and uncolored output options.

import { u } from 'unist-builder';
import { inspect } from 'unist-util-inspect';

const complexTree = u('root', [
  u('paragraph', [
    u('text', 'Hello, world!'),
    u('emphasis', [u('text', 'This is emphasized.')])
  ]),
  u('list', { ordered: true }, [
    u('listItem', [u('text', 'First item')]),
    u('listItem', [u('strong', [u('text', 'Second item with strong text')])])
  ]),
  u('code', { lang: 'js' }, 'console.log("Code example");')
]);

console.log('--- Uncolored Inspection ---');
console.log(inspect(complexTree, { color: false, showPositions: true }));

console.log('\n--- Colored Inspection (default) ---');
console.log(inspect(complexTree));

// Demonstrates basic usage and optional parameters for output control.