mdast Phrasing Content Utility

Common errors

• ERR_REQUIRE_ESM

  cause Attempting to use `require()` to import `mdast-util-phrasing` after version 3.0.0, which is an ESM-only package.
  fix Change your import statement to `import { phrasing } from 'mdast-util-phrasing'` and ensure your environment supports ESM (e.g., `type: "module"` in `package.json` for Node.js).

• TypeError: mdast_util_phrasing_1.phrasing is not a function

  cause Incorrectly importing `phrasing` as a default export, when it is a named export.
  fix Use a named import: `import { phrasing } from 'mdast-util-phrasing';`

• Module '"mdast-util-phrasing"' has no exported member 'phrasing'.

  cause This TypeScript error often occurs due to mismatched `@types/mdast` versions or using an unsupported Node.js version (pre-16) with `mdast-util-phrasing@4+`.
  fix Ensure your Node.js version is 16 or newer. Update `@types/mdast` and `mdast-util-phrasing` to their latest compatible versions.

Warnings

• breaking Version 4.0.0 changed to require Node.js 16 or newer and utilizes an `export` map. Older Node.js versions are no longer supported.
  Fix: Upgrade your Node.js environment to version 16 or later. If using a bundler, ensure it supports `export` maps.
• breaking Version 3.0.0 switched the package to be ESM-only. CommonJS `require()` statements will no longer work.
  Fix: Migrate your codebase to use ECMAScript Modules (ESM) `import` syntax. Ensure your `package.json` has `"type": "module"` or use `.mjs` file extensions.
• breaking Version 2.0.0 updated its dependency on `unist-util-is` which could be a breaking change, particularly for TypeScript users relying on specific type definitions from `unist-util-is`.
  Fix: Update `mdast-util-phrasing` and its peer dependencies (like `@types/mdast`) to the latest compatible versions to ensure correct type resolution.
• gotcha The `phrasing` function explicitly excludes `html` nodes from its check, returning `false` for them. This is because HTML can represent both phrasing and flow content, and the utility takes a conservative approach.
  Fix: If you need to classify `html` nodes, you will need to implement a custom check or use `hast-util-phrasing` for hast trees.

Install

• npm install mdast-util-phrasing npm
• yarn add mdast-util-phrasing yarn
• pnpm add mdast-util-phrasing pnpm

Imports

• phrasing
  wrong:

  const phrasing = require('mdast-util-phrasing')

  correct:

  import { phrasing } from 'mdast-util-phrasing'

  Package is ESM-only since v3.0.0; CommonJS `require` is not supported. There is no default export.
• phrasing
  wrong:

  import phrasing from 'mdast-util-phrasing'

  correct:

  import { phrasing } from 'mdast-util-phrasing'

  The package does not have a default export; `phrasing` must be imported as a named export.
• Node

  import type { Node } from 'mdast'

  This package ships its own types but works with `mdast` nodes. For `Node` types, import from the `mdast` package.

Quickstart

Demonstrates how to import and use the `phrasing` function to determine if an mdast node is phrasing content, showing examples for paragraph, strong, and HTML nodes.

import { phrasing } from 'mdast-util-phrasing';
import { paragraph, strong, text } from 'mdast-builder';

// Example 1: A paragraph is not phrasing content
const paragraphNode = paragraph([text('Alpha')]);
console.log(`Is paragraph node phrasing content? ${phrasing(paragraphNode)}`);

// Example 2: A strong node (inline) is phrasing content
const strongNode = strong([text('Delta')]);
console.log(`Is strong node phrasing content? ${phrasing(strongNode)}`);

// Example 3: An HTML node is explicitly excluded and returns false
const htmlNode = { type: 'html', value: '<span>Hello</span>' };
console.log(`Is HTML node phrasing content? ${phrasing(htmlNode)}`);

// Output:
// Is paragraph node phrasing content? false
// Is strong node phrasing content? true
// Is HTML node phrasing content? false