mdast-util-phrasing

What is mdast-util-phrasing?

The `mdast-util-phrasing` package is a utility for working with MDAST (Markdown Abstract Syntax Tree) nodes that are considered 'phrasing content'. Phrasing content includes text and inline elements that can appear within a paragraph in Markdown. This package helps in identifying and manipulating such nodes.

What are mdast-util-phrasing's main functionalities?

Check if a node is phrasing content

This feature allows you to check if a given MDAST node is considered phrasing content. In the example, the node is a text node, which is phrasing content, so the function returns true.

const { phrasing } = require('mdast-util-phrasing');
const node = { type: 'text', value: 'Hello, world!' };
console.log(phrasing(node)); // true

Filter phrasing content from a list of nodes

This feature allows you to filter out only the phrasing content nodes from a list of MDAST nodes. In the example, only the text node is considered phrasing content, so it is the only node that remains after filtering.

const { phrasing } = require('mdast-util-phrasing');
const nodes = [
  { type: 'text', value: 'Hello, world!' },
  { type: 'paragraph', children: [] }
];
const phrasingNodes = nodes.filter(phrasing);
console.log(phrasingNodes); // [{ type: 'text', value: 'Hello, world!' }]

Other packages similar to mdast-util-phrasing

unist-util-visit

The `unist-util-visit` package is a utility for recursively visiting nodes in a Unist syntax tree, which includes MDAST. While it doesn't specifically focus on phrasing content, it can be used to traverse and manipulate nodes in a similar way.

mdast-util-to-string

The `mdast-util-to-string` package is used to get the plain text content of an MDAST node. It is useful for extracting text from nodes, but it doesn't specifically identify or filter phrasing content like `mdast-util-phrasing`.

unist-util-select

The `unist-util-select` package allows you to select nodes in a Unist tree using CSS-like selectors. It can be used to find and manipulate specific types of nodes, including phrasing content, but it uses a different approach compared to `mdast-util-phrasing`.

README

mdast-util-phrasing

Check if a MDAST (markdown) node is a phrasing element.

Installation

npm:

npm install mdast-util-phrasing

Usage

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

phrasing({
  type: 'paragraph',
  children: [{type: 'text', value: 'Alpha'}]
}) // => false

phrasing({
  type: 'strong',
  children: [{type: 'text', value: 'Delta'}]
}) // => true

API

phrasing(node)

Check if the given value is a phrasing element.

Parameters

node (*) — Value to check.

Returns

boolean — whether node passes the test.

Contribute

See contributing.md in syntax-tree/mdast for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT