unist-util-stringify-position

What is unist-util-stringify-position?

The `unist-util-stringify-position` package is a utility for converting Unist node positions to a string format. Unist nodes are part of the Unified ecosystem, which is used for processing content with abstract syntax trees (ASTs). This package helps in serializing the position of nodes (such as where they start and end in the source document) into a human-readable string format, which can be useful for debugging, logging, or displaying position information in user interfaces.

What are unist-util-stringify-position's main functionalities?

Stringify a single position

This feature allows you to convert a single position object, which includes start and end properties with line and column information, into a string. It's useful for representing the location of a node in a source file.

"const stringify = require('unist-util-stringify-position');\nconst position = {start: {line: 1, column: 1}, end: {line: 1, column: 4}};\nconsole.log(stringify(position)); // Outputs '1:1-1:4'"

Stringify a node with position

This feature demonstrates how to stringify the position of an entire Unist node. It's particularly useful when working with ASTs and you need to log or display where a node is located within the original document.

"const stringify = require('unist-util-stringify-position');\nconst node = {type: 'text', value: 'example', position: {start: {line: 2, column: 3}, end: {line: 2, column: 10}}};\nconsole.log(stringify(node)); // Outputs '2:3-2:10'"

Other packages similar to unist-util-stringify-position

unist-util-visit

While `unist-util-visit` does not directly stringify positions, it is a utility for traversing Unist trees and can be used in conjunction with `unist-util-stringify-position` to visit nodes and stringify their positions. It differs in its primary purpose, focusing on tree traversal rather than position serialization.

README

unist-util-stringify-position

unist utility to pretty print the positional info of a node.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • stringifyPosition(node|position|point)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a utility that takes any unist (whether mdast, hast, etc) node, position, or point, and serializes its positional info.

When should I use this?

This utility is useful to display where something occurred in the original document, in one standard way, for humans. For example, when throwing errors or warning messages about something.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install unist-util-stringify-position

In Deno with esm.sh:

import {stringifyPosition} from 'https://esm.sh/unist-util-stringify-position@4'

In browsers with esm.sh:

<script type="module">
  import {stringifyPosition} from 'https://esm.sh/unist-util-stringify-position@4?bundle'
</script>

Use

import {stringifyPosition} from 'unist-util-stringify-position'

stringifyPosition({line: 2, column: 3}) // => '2:3' (point)
stringifyPosition({start: {line: 2}, end: {line: 3}}) // => '2:1-3:1' (position)
stringifyPosition({
  type: 'text',
  value: '!',
  position: {
    start: {line: 5, column: 11},
    end: {line: 5, column: 12}
  }
}) // => '5:11-5:12' (node)

API

This package exports the identifier stringifyPosition. There is no default export.

stringifyPosition(node|position|point)

Serialize the positional info of a point, position (start and end points), or node.

Parameters

• node (Node) — node whose position fields to serialize
• position (Position) — position whose start and end points to serialize
• point (Point) — point whose line and column fields to serialize

Returns

Pretty printed positional info of a node (string).

In the format of a range ls:cs-le:ce (when given node or position) or a point l:c (when given point), where l stands for line, c for column, s for start, and e for end. An empty string ('') is returned if the given value is neither node, position, nor point.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

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-stringify-position@^4, compatible with Node.js 16.

Security

This project is safe.

Related

• unist-util-generated — check if a node is generated
• unist-util-position — get positional info of nodes
• unist-util-remove-position — remove positional info from trees
• unist-util-source — get the source of a value (node or position) in a file

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