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 information of a node.

Install

npm:

npm install unist-util-stringify-position

Usage

var stringify = require('unist-util-stringify-position')

// Point
stringify({line: 2, column: 3}) // => '2:3'

// Position
stringify({start: {line: 2}, end: {line: 3}}) // => '2:1-3:1'

// Node
stringify({
  type: 'text',
  value: '!',
  position: {
    start: {line: 5, column: 11},
    end: {line: 5, column: 12}
  }
}) // => '5:11-5:12'

API

stringifyPosition(node|position|point)

Stringify one point, a position (start and end points), or a node’s positional information.

Parameters

• node (Node) — Node whose 'position' property to stringify
• position (Position) — Position whose 'start' and 'end' points to stringify
• point (Point) — Point whose 'line' and 'column' to stringify

Returns

string? — 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.

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer