Brunobkr/llama.cpp_AlgMor24_github

1# unist-util-stringify-position2 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[unist][] utility to pretty print the positional info of a node.12 13## Contents14 15*   [What is this?](#what-is-this)16*   [When should I use this?](#when-should-i-use-this)17*   [Install](#install)18*   [Use](#use)19*   [API](#api)20    *   [`stringifyPosition(node|position|point)`](#stringifypositionnodepositionpoint)21*   [Types](#types)22*   [Compatibility](#compatibility)23*   [Security](#security)24*   [Related](#related)25*   [Contribute](#contribute)26*   [License](#license)27 28## What is this?29 30This package is a utility that takes any [unist][] (whether mdast, hast, etc)31node, position, or point, and serializes its positional info.32 33## When should I use this?34 35This utility is useful to display where something occurred in the original36document, in one standard way, for humans.37For example, when throwing errors or warning messages about something.38 39## Install40 41This package is [ESM only][esm].42In Node.js (version 16+), install with [npm][]:43 44```sh45npm install unist-util-stringify-position46```47 48In Deno with [`esm.sh`][esmsh]:49 50```js51import {stringifyPosition} from 'https://esm.sh/unist-util-stringify-position@4'52```53 54In browsers with [`esm.sh`][esmsh]:55 56```html57<script type="module">58  import {stringifyPosition} from 'https://esm.sh/unist-util-stringify-position@4?bundle'59</script>60```61 62## Use63 64```js65import {stringifyPosition} from 'unist-util-stringify-position'66 67stringifyPosition({line: 2, column: 3}) // => '2:3' (point)68stringifyPosition({start: {line: 2}, end: {line: 3}}) // => '2:1-3:1' (position)69stringifyPosition({70  type: 'text',71  value: '!',72  position: {73    start: {line: 5, column: 11},74    end: {line: 5, column: 12}75  }76}) // => '5:11-5:12' (node)77```78 79## API80 81This package exports the identifier [`stringifyPosition`][stringifyposition].82There is no default export.83 84### `stringifyPosition(node|position|point)`85 86Serialize the positional info of a point, position (start and end points), or87node.88 89###### Parameters90 91*   `node` ([`Node`][node])92    — node whose `position` fields to serialize93*   `position` ([`Position`][position])94    — position whose `start` and `end` points to serialize95*   `point` ([`Point`][point])96    — point whose `line` and `column` fields to serialize97 98###### Returns99 100Pretty printed positional info of a node (`string`).101 102In the format of a range `ls:cs-le:ce` (when given `node` or `position`) or a103point `l:c` (when given `point`), where `l` stands for line, `c` for column, `s`104for `start`, and `e` for end.105An empty string (`''`) is returned if the given value is neither `node`,106`position`, nor `point`.107 108## Types109 110This package is fully typed with [TypeScript][].111It exports no additional types.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,121`unist-util-stringify-position@^4`, compatible with Node.js 16.122 123## Security124 125This project is safe.126 127## Related128 129*   [`unist-util-generated`](https://github.com/syntax-tree/unist-util-generated)130    — check if a node is generated131*   [`unist-util-position`](https://github.com/syntax-tree/unist-util-position)132    — get positional info of nodes133*   [`unist-util-remove-position`](https://github.com/syntax-tree/unist-util-remove-position)134    — remove positional info from trees135*   [`unist-util-source`](https://github.com/syntax-tree/unist-util-source)136    — get the source of a value (node or position) in a file137 138## Contribute139 140See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get141started.142See [`support.md`][support] for ways to get help.143 144This project has a [code of conduct][coc].145By interacting with this repository, organization, or community you agree to146abide by its terms.147 148## License149 150[MIT][license] © [Titus Wormer][author]151 152<!-- Definition -->153 154[build-badge]: https://github.com/syntax-tree/unist-util-stringify-position/workflows/main/badge.svg155 156[build]: https://github.com/syntax-tree/unist-util-stringify-position/actions157 158[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-stringify-position.svg159 160[coverage]: https://codecov.io/github/syntax-tree/unist-util-stringify-position161 162[downloads-badge]: https://img.shields.io/npm/dm/unist-util-stringify-position.svg163 164[downloads]: https://www.npmjs.com/package/unist-util-stringify-position165 166[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=unist-util-stringify-position167 168[size]: https://bundlejs.com/?q=unist-util-stringify-position169 170[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg171 172[backers-badge]: https://opencollective.com/unified/backers/badge.svg173 174[collective]: https://opencollective.com/unified175 176[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg177 178[chat]: https://github.com/syntax-tree/unist/discussions179 180[npm]: https://docs.npmjs.com/cli/install181 182[license]: license183 184[author]: https://wooorm.com185 186[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c187 188[esmsh]: https://esm.sh189 190[typescript]: https://www.typescriptlang.org191 192[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md193 194[support]: https://github.com/syntax-tree/.github/blob/main/support.md195 196[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md197 198[unist]: https://github.com/syntax-tree/unist199 200[node]: https://github.com/syntax-tree/unist#node201 202[position]: https://github.com/syntax-tree/unist#position203 204[point]: https://github.com/syntax-tree/unist#point205 206[stringifyposition]: #stringifypositionnodepositionpoint207