Project: vfile/vfile-location

Package: vfile-location@4.0.1

  1. Dependents: 0
  2. vfile utility to convert between positional (line and column-based) and offset (range-based) locations
  1. util 145
  2. utility 141
  3. file 34
  4. virtual 18
  5. vfile 17
  6. vfile-util 15
  7. position 9
  8. location 4
  9. point 3


Build Coverage Downloads Size Sponsors Backers Chat

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


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.


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'


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}


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


Create an index of the given document to translate between line/column and offset based positional info.


Accessors for index (Location).


Accessors for index (TypeScript type).



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


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.


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.


MIT © Titus Wormer