vfile-location
v5.0.3
Published
vfile utility to convert between positional (line and column-based) and offset (range-based) locations
Downloads
20,960,933
Maintainers
Readme
vfile-location
vfile utility to convert between positional (line and column-based) and offsets (range-based) locations.
Contents
What is this?
This is a tiny but useful package to convert between arbitrary places in a file.
When should I use this?
This utility is useful when ASTs nodes don’t cut it. For example, when you are making a lint rule that looks for dangerous characters in a file, which you accomplish by searching the raw file value, and still want to report it to users.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install vfile-location
In Deno with esm.sh
:
import {location} from 'https://esm.sh/vfile-location@5'
In browsers with esm.sh
:
<script type="module">
import {location} from 'https://esm.sh/vfile-location@5?bundle'
</script>
Use
import {VFile} from 'vfile'
import {location} from 'vfile-location'
const place = location(new VFile('foo\nbar\nbaz'))
const offset = place.toOffset({line: 3, column: 3}) // => 10
place.toPoint(offset) // => {line: 3, column: 3, offset: 10}
API
Location
Accessors for index.
Fields
toOffset
((point?: PointLike | null | undefined) => number | undefined
) — get theoffset
from a line/column basedPoint
in the bound indices; returnsundefined
when given out of bounds inputtoPoint
((offset?: number | null | undefined) => UnistPoint | undefined
) — get the line/column basedPoint
foroffset
in the bound indices; returnsundefined
when given out of bounds input
location(file)
Create an index of the given document to translate between line/column and offset based positional info.
Also implemented in Rust in wooorm/markdown-rs
.
Parameters
file
(VFile | Value
) — file to index
Returns
Accessors for index (Location
).
Types
This package is fully typed with TypeScript.
It exports the additional type Location
.
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, vfile-location@^5
,
compatible with Node.js 16.
Contribute
See contributing.md
in vfile/.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.