unist-util-position-from-estree
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatunist utility to get a position from an estree node.
Contents
* [`positionFromEstree(node)`](#positionfromestreenode)
What is this?
This package is a tiny utility that can create a proper unist position from an estree nodeWhen should I use this?
You can use this package when you want to use other unist utilities with estree nodes.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install unist-util-position-from-estree
In Deno with
esm.sh
esmsh:import {positionFromEstree} from 'https://esm.sh/unist-util-position-from-estree@2'
In browsers with
esm.sh
esmsh:<script type="module">
import {positionFromEstree} from 'https://esm.sh/unist-util-position-from-estree@2?bundle'
</script>
Use
import {parse} from 'acorn'
import {positionFromEstree} from 'unist-util-position-from-estree'
// Make acorn support line/column.
const node = parse('function x() { console.log(1) }', {
ecmaVersion: 2020,
locations: true
})
console.log(positionFromEstree(node)) // `Program`
console.log(positionFromEstree(node.body[0].id)) // `x`
console.log(positionFromEstree(node.body[0].body.body[0].expression)) // Call
Yields:
{
start: {line: 1, column: 1, offset: 0},
end: {line: 1, column: 32, offset: 31}
}
{
start: {line: 1, column: 10, offset: 9},
end: {line: 1, column: 11, offset: 10}
}
{
start: {line: 1, column: 16, offset: 15},
end: {line: 1, column: 30, offset: 29}
}
API
This package exports the identifierpositionFromEstree
positionfromestree.
There is no default export.positionFromEstree(node)
Turn an estree node
into a unist position
.Parameters
— estree node
Returns
unist position, if valid (Position
position or undefined
).Types
This package is fully typed with TypeScript. It exports no additional types.Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,
unist-util-position-from-estree@^2
, compatible with Node.js 16.Contribute
Seecontributing.md
contributing in syntax-tree/.github
health for
ways to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.