Repository files navigation

unist utility to get positional info of nodes.

• What is this?
• When should I use this?
• Install
• Use
• API
  • position(node)
  • pointEnd(node)
  • pointStart(node)
• Types
• Compatibility
• Related
• Contribute
• License

This utility helps with accessing positional info on a potentially dirty tree.

The positional info is typically consistent and proper in unist trees generatedby our ecosystem, but, user plugins could mess that up.If you’re making a reusable plugin, and accessing the positional info often, youmight want to guard against that by using this utility.

You might also find the utilityunist-util-generateduseful to check whether a node is considered to be generated (not in theoriginal input file).

You might also enjoyunist-util-stringify-position when you wantto display positional info to users.

This package isESM only.In Node.js (version 16+), install withnpm:

npm install unist-util-position

In Deno withesm.sh:

import{pointEnd,pointStart,position}from'https://esm.sh/unist-util-position@5'

In browsers withesm.sh:

<scripttype="module">import{pointEnd,pointStart,position}from'https://esm.sh/unist-util-position@5?bundle'</script>

import{fromMarkdown}from'mdast-util-from-markdown'import{pointEnd,pointStart,position}from'unist-util-position'consttree=fromMarkdown('# foo\n\n* bar\n')console.log(position(tree))console.log(pointStart(tree))console.log(pointEnd(tree))

Yields:

{start:{line:1,column:1,offset:0},end:{line:4,column:1,offset:13}}{line:1,column:1,offset:0}{line:4,column:1,offset:13}

This package exports the identifierspointEnd,pointStart, andposition.There is no default export.

Get the positional info ofnode.

• node (Node)— node

Position, if valid (Position orundefined).

Get the ending point ofnode.

• node (Node)— node

Point, if valid (Point orundefined).

Get the starting point ofnode.

• node (Node)— node

Point, if valid (Point orundefined).

This package is fully typed withTypeScript.It exports no additional types.

Projects maintained by the unified collective are compatible with maintainedversions of Node.js.

When we cut a new major release, we drop support for unmaintained versions ofNode.This means we try to keep the current release line,unist-util-position@^5,compatible with Node.js 16.

• unist-util-stringify-position— serialize a node, position, or point as a human readable location
• unist-util-position-from-estree— get a position from an estree node
• unist-util-remove-position— remove positions from tree
• unist-util-generated— check if a node is generated
• unist-util-source— get the source of a node

Seecontributing.md insyntax-tree/.github forways to get started.Seesupport.md for ways to get help.

This project has acode of conduct.By interacting with this repository, organization, or community you agree toabide by its terms.

MIT ©Titus Wormer