unified

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

Package: unist-util-stringify-position@2.0.3

  1. Dependencies: 1·Dependents: 14
  2. unist utility to serialize a node, position, or point as a human readable location
  1. util 107
  2. utility 105
  3. unist 97
  4. unist-util 24
  5. node 21
  6. stringify 15
  7. position 8
  8. location 4
  9. point 2
  10. tostring 2

unist-util-stringify-position

Build Coverage Downloads Size Sponsors Backers Chat

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

Install

npm:

npm install unist-util-stringify-position

Use

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
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.

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