unified

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 147
  2. utility 143
  3. file 34
  4. virtual 19
  5. vfile 17
  6. vfile-util 15
  7. position 9
  8. location 4
  9. point 3

vfile-location

Build Coverage Downloads Size Sponsors Backers Chat

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 12.20+, 14.14+, 16.0+, or 18.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.

place = location(doc)

Index doc (string or VFile) and get functions for it. Returns an object with toOffset and toPoint.

place.toOffset(point)

Get the offset (number) for a line and column-based Point in the bound file. Returns -1 when given invalid or out of bounds input.

place.toPoint(offset)

Get the line and column-based Point for offset in the bound file.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.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.

License

MIT © Titus Wormer