Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

unist-util-stringify-position

Package Overview
Dependencies
1
Maintainers
2
Versions
11
Issues
File Explorer

Advanced tools

unist-util-stringify-position

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

    3.0.2latest

Version published
Maintainers
2
Weekly downloads
8,393,800
decreased by-11.31%

Weekly downloads

Changelog

Source

3.0.2

  • 3b9f4cd Fix types to support instances of Node again

Full Changelog: https://github.com/syntax-tree/unist-util-stringify-position/compare/3.0.1...3.0.2

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/[email protected]'

In browsers with esm.sh:

<script type="module"> import {stringifyPosition} from 'https://esm.sh/[email protected]?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

What is unist-util-stringify-position?

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

Is unist-util-stringify-position popular?

The npm package unist-util-stringify-position receives a total of 6,745,998 weekly downloads. As such, unist-util-stringify-position popularity was classified as popular.

Is unist-util-stringify-position well maintained?

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.

Last updated on 03 Mar 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc