Negligible Psychological Misery

    unist-util-stringify-position
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.3 • Public • Published

    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 14.14+ and 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)

    Serialize the positional info of a point, position (start and end points), or node.

    Parameters
    • node (Node) — node whose position fields to serialize
    • position (Position) — position whose start and end points to serialize
    • point (Point) — point whose line and column fields to serialize
    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 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    Security

    This project is safe.

    Related

    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

    Install

    npm i unist-util-stringify-position

    DownloadsWeekly Downloads

    9,632,069

    Version

    3.0.3

    License

    MIT

    Unpacked Size

    13.1 kB

    Total Files

    7

    Last publish

    Collaborators

    • wooorm
    • kmck