unified

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

Package:unist-util-stringify-position@2.0.2

  1. Dependencies:1·Dependents:10
  2. Stringify a Unist node, position, or point
  1. util 51
  2. utility 48
  3. unist 36
  4. node 21
  5. stringify 14
  6. position 6
  7. location 3
  8. point 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

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

License

MIT © Titus Wormer