Socket
Socket
Sign inDemoInstall

unist-util-stringify-position

Package Overview
Dependencies
1
Maintainers
2
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

unist-util-stringify-position

unist utility to serialize a node, position, or point as a human readable location


Version published
Maintainers
2
Weekly downloads
11,777,352
decreased by-7.15%

Weekly downloads

Package description

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

Readme

Source

unist-util-stringify-position

Build Coverage Downloads Size Sponsors Backers Chat

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

Contents

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 12.20+, 14.14+, or 16.0+), install with npm:

npm install unist-util-stringify-position

In Deno with esm.sh:

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

In browsers with esm.sh:

<script type="module">
  import {stringifyPosition} from 'https://esm.sh/unist-util-stringify-position@3?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)

Stringify a point, position, or a node.

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.

Types

This package is fully typed with TypeScript. There are no additional types exported.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Security

This project is safe.

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

Keywords

FAQs

Last updated on 03 Mar 2022

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc