vfile-location

vfile utility to convert between positional (line and column-based) and offsets (range-based) locations.

What is this?
When should I use this?
Install
Use
API
- location(file)
- Location
Types
Compatibility
Contribute
License

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 14.14+ and 16.0+), install with npm:

npm install vfile-location

In Deno with esm.sh:

import {location} from 'https://esm.sh/vfile-location@4'

In browsers with esm.sh:

<script type="module">
  import {location} from 'https://esm.sh/vfile-location@4?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

This package exports the identifier location. There is no default export.

`location(file)`

Index the given document so you can translate between line/column and offset based positional info.

Parameters

file (string, Buffer, or VFile) — file to index

Returns

Accessors for index (Location).

`Location`

Accessors for index (TypeScript type).

Fields

toPoint ((offset?: number) => Point) — get a line/column-based Point from offset
toOffset ((point?: Point) => number) — get an offset from a line/column-based point

Types

This package is fully typed with TypeScript. It exports the additional type Location.

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.

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.