Brunobkr/llama.cpp_AlgMor24_github

1# vfile-location2 3[![Build][build-badge]][build]4[![Coverage][coverage-badge]][coverage]5[![Downloads][downloads-badge]][downloads]6[![Size][size-badge]][size]7[![Sponsors][sponsors-badge]][collective]8[![Backers][backers-badge]][collective]9[![Chat][chat-badge]][chat]10 11[vfile][] utility to convert between positional (line and column-based) and12offsets (range-based) locations.13 14## Contents15 16* [What is this?](#what-is-this)17* [When should I use this?](#when-should-i-use-this)18* [Install](#install)19* [Use](#use)20* [API](#api)21  * [`Location`](#location)22  * [`location(file)`](#locationfile)23* [Types](#types)24* [Compatibility](#compatibility)25* [Contribute](#contribute)26* [License](#license)27 28## What is this?29 30This is a tiny but useful package to convert between arbitrary places in a31file.32 33## When should I use this?34 35This utility is useful when ASTs nodes don’t cut it.36For example, when you are making a lint rule that looks for dangerous37characters in a file, which you accomplish by searching the raw file value,38and still want to report it to users.39 40## Install41 42This package is [ESM only][esm].43In Node.js (version 16+), install with [npm][]:44 45```sh46npm install vfile-location47```48 49In Deno with [`esm.sh`][esmsh]:50 51```js52import {location} from 'https://esm.sh/vfile-location@5'53```54 55In browsers with [`esm.sh`][esmsh]:56 57```html58<script type="module">59  import {location} from 'https://esm.sh/vfile-location@5?bundle'60</script>61```62 63## Use64 65```js66import {VFile} from 'vfile'67import {location} from 'vfile-location'68 69const place = location(new VFile('foo\nbar\nbaz'))70 71const offset = place.toOffset({line: 3, column: 3}) // => 1072place.toPoint(offset) // => {line: 3, column: 3, offset: 10}73```74 75## API76 77### `Location`78 79Accessors for index.80 81###### Fields82 83* `toOffset` (`(point?: PointLike | null | undefined) => number | undefined`)84  — get the `offset` from a line/column based `Point` in the bound indices;85  returns `undefined` when given out of bounds input86* `toPoint` (`(offset?: number | null | undefined) => UnistPoint | undefined`)87  — get the line/column based `Point` for `offset` in the bound indices;88  returns `undefined` when given out of bounds input89 90### `location(file)`91 92Create an index of the given document to translate between line/column and93offset based positional info.94 95Also implemented in Rust in [`wooorm/markdown-rs`][markdown-rs].96 97[markdown-rs]: https://github.com/wooorm/markdown-rs/blob/main/src/util/location.rs98 99###### Parameters100 101* `file` (`VFile | Value`)102  — file to index103 104###### Returns105 106Accessors for index (`Location`).107 108## Types109 110This package is fully typed with [TypeScript][].111It exports the additional type [`Location`][api-location-map].112 113## Compatibility114 115Projects maintained by the unified collective are compatible with maintained116versions of Node.js.117 118When we cut a new major release, we drop support for unmaintained versions of119Node.120This means we try to keep the current release line, `vfile-location@^5`,121compatible with Node.js 16.122 123## Contribute124 125See [`contributing.md`][contributing] in [`vfile/.github`][health] for ways to126get started.127See [`support.md`][support] for ways to get help.128 129This project has a [code of conduct][coc].130By interacting with this repository, organization, or community you agree to131abide by its terms.132 133## License134 135[MIT][license] © [Titus Wormer][author]136 137<!-- Definitions -->138 139[build-badge]: https://github.com/vfile/vfile-location/workflows/main/badge.svg140 141[build]: https://github.com/vfile/vfile-location/actions142 143[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-location.svg144 145[coverage]: https://codecov.io/github/vfile/vfile-location146 147[downloads-badge]: https://img.shields.io/npm/dm/vfile-location.svg148 149[downloads]: https://www.npmjs.com/package/vfile-location150 151[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=vfile-location152 153[size]: https://bundlejs.com/?q=vfile-location154 155[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg156 157[backers-badge]: https://opencollective.com/unified/backers/badge.svg158 159[collective]: https://opencollective.com/unified160 161[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg162 163[chat]: https://github.com/vfile/vfile/discussions164 165[npm]: https://docs.npmjs.com/cli/install166 167[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c168 169[esmsh]: https://esm.sh170 171[typescript]: https://www.typescriptlang.org172 173[contributing]: https://github.com/vfile/.github/blob/main/contributing.md174 175[support]: https://github.com/vfile/.github/blob/main/support.md176 177[health]: https://github.com/vfile/.github178 179[coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md180 181[license]: license182 183[author]: https://wooorm.com184 185[vfile]: https://github.com/vfile/vfile186 187[api-location-map]: #location188