unified

Project: syntax-tree/unist-util-stringify-position

Package: unist-util-stringify-position@3.0.2

  1. Dependents: 0
  2. unist utility to serialize a node, position, or point as a human readable location
  1. util 147
  2. utility 143
  3. unist 133
  4. unist-util 25
  5. node 25
  6. stringify 19
  7. position 9
  8. location 4
  9. point 3
  10. tostring 3

unist-util-stringify-position

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to pretty print the positional info 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+, 16.0+, or 18.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 node.

Parameters
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 all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.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