unist-util-stringify-position
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/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})
stringifyPosition({start: {line: 2}, end: {line: 3}})
stringifyPosition({
type: 'text',
value: '!',
position: {
start: {line: 5, column: 11},
end: {line: 5, column: 12}
}
})
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 stringifyposition
(Position
)
— position whose 'start'
and 'end'
points to stringifypoint
(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.
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