diff options
Diffstat (limited to 'tools/node_modules/eslint/node_modules/vfile-location/readme.md')
-rw-r--r-- | tools/node_modules/eslint/node_modules/vfile-location/readme.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/vfile-location/readme.md b/tools/node_modules/eslint/node_modules/vfile-location/readme.md new file mode 100644 index 0000000000..c9bad64cce --- /dev/null +++ b/tools/node_modules/eslint/node_modules/vfile-location/readme.md @@ -0,0 +1,72 @@ +# vfile-location [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov] + +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')); + +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. + +## License + +[MIT][license] © [Titus Wormer][author] + +<!-- Definitions --> + +[travis-badge]: https://img.shields.io/travis/vfile/vfile-location.svg + +[travis]: https://travis-ci.org/vfile/vfile-location + +[codecov-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-location.svg + +[codecov]: https://codecov.io/github/vfile/vfile-location + +[npm]: https://docs.npmjs.com/cli/install + +[license]: LICENSE + +[author]: http://wooorm.com + +[vfile]: https://github.com/vfile/vfile + +[to-offset]: #locationtooffsetposition + +[to-position]: #locationtopositionoffset + +[position]: https://github.com/syntax-tree/unist#position |