unist-util-stringify-position
Advanced tools
Package description
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.
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'"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.
This hypothetical package (note: `unist-util-locate` does not actually exist) would presumably offer functionality to locate nodes within a Unist tree, potentially providing similar position information. However, without direct stringification capabilities, it would serve a complementary rather than overlapping role with `unist-util-stringify-position`.
Readme
unist utility to pretty print the positional information of a node.
npm:
npm install unist-util-stringify-position
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'
stringifyPosition(node|position|point)Stringify one point, a position (start and end points), or a node’s positional information.
node (Node)
— Node whose 'position' property to stringifyposition (Position)
— Position whose 'start' and 'end' points to stringifypoint (Point)
— Point whose 'line' and 'column' to stringifystring? — 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.
unist-util-generated
— Check if a node is generatedunist-util-position
— Get positional info of nodesunist-util-remove-position
— Remove positional info from treesunist-util-source
— Get the source of a value (node or position) in a fileSee 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.
FAQs
unist utility to serialize a node, position, or point as a human readable location
The npm package unist-util-stringify-position receives a total of 10,014,700 weekly downloads. As such, unist-util-stringify-position popularity was classified as popular.
We found that unist-util-stringify-position demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.