blob: 8b2d91f1564e6f15b9f482816bd7bfdb51eacaf4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
# vfile-location
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Chat][chat-badge]][chat]
Convert between positions (line and column-based) and offsets
(range-based) locations in a [virtual file][vfile].
## Installation
[npm][]:
```bash
npm install vfile-location
```
## Usage
```js
var vfile = require('vfile')
var vfileLocation = require('vfile-location')
var location = vfileLocation(vfile('foo\nbar\nbaz'))
var offset = location.toOffset({line: 3, column: 3}) // => 10
location.toPosition(offset) // => {line: 3, column: 3, offset: 10}
```
## API
### `location = vfileLocation(doc)`
Get transform functions for the given `doc` (`string`) or
[`file`][vfile].
Returns an object with [`toOffset`][to-offset] and
[`toPosition`][to-position].
### `location.toOffset(position)`
Get the `offset` (`number`) for a line and column-based
[`position`][position] in the bound file. Returns `-1`
when given invalid or out of bounds input.
### `location.toPosition(offset)`
Get the line and column-based [`position`][position] for `offset` in
the bound file.
## Contribute
See [`contributing.md` in `vfile/vfile`][contributing] for ways to get started.
This organisation has a [Code of Conduct][coc]. By interacting with this
repository, organisation, or community you agree to abide by its terms.
## License
[MIT][license] © [Titus Wormer][author]
<!-- Definitions -->
[build-badge]: https://img.shields.io/travis/vfile/vfile-location.svg
[build]: https://travis-ci.org/vfile/vfile-location
[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-location.svg
[coverage]: https://codecov.io/github/vfile/vfile-location
[downloads-badge]: https://img.shields.io/npm/dm/vfile-location.svg
[downloads]: https://www.npmjs.com/package/vfile-location
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
[chat]: https://spectrum.chat/unified/vfile
[npm]: https://docs.npmjs.com/cli/install
[license]: license
[author]: https://wooorm.com
[vfile]: https://github.com/vfile/vfile
[to-offset]: #locationtooffsetposition
[to-position]: #locationtopositionoffset
[position]: https://github.com/syntax-tree/unist#position
[contributing]: https://github.com/vfile/vfile/blob/master/contributing.md
[coc]: https://github.com/vfile/vfile/blob/master/code-of-conduct.md
|
