Brunobkr/llama.cpp_AlgMor24_github

1# unist-util-visit2 3[![Build][badge-build-image]][badge-build-url]4[![Coverage][badge-coverage-image]][badge-coverage-url]5[![Downloads][badge-downloads-image]][badge-downloads-url]6[![Size][badge-size-image]][badge-size-url]7 8[unist][github-unist] utility to walk the tree.9 10## Contents11 12* [What is this?](#what-is-this)13* [When should I use this?](#when-should-i-use-this)14* [Install](#install)15* [Use](#use)16* [API](#api)17  * [`visit(tree[, test], visitor[, reverse])`](#visittree-test-visitor-reverse)18  * [`CONTINUE`](#continue)19  * [`EXIT`](#exit)20  * [`SKIP`](#skip)21  * [`Action`](#action)22  * [`ActionTuple`](#actiontuple)23  * [`BuildVisitor`](#buildvisitor)24  * [`Index`](#index)25  * [`Test`](#test)26  * [`Visitor`](#visitor)27  * [`VisitorResult`](#visitorresult)28* [Compatibility](#compatibility)29* [Related](#related)30* [Contribute](#contribute)31* [License](#license)32 33## What is this?34 35This is a very important utility for working with unist as it lets you walk the36tree.37 38## When should I use this?39 40You can use this utility when you want to walk the tree.41You can use [`unist-util-visit-parents`][github-vp] if you care about the42entire stack of parents.43 44## Install45 46This package is [ESM only][github-gist-esm].47In Node.js (version 16+),48install with [npm][npmjs-install]:49 50```sh51npm install unist-util-visit52```53 54In Deno with [`esm.sh`][esmsh]:55 56```js57import {CONTINUE, EXIT, SKIP, visit} from 'https://esm.sh/unist-util-visit@5'58```59 60In browsers with [`esm.sh`][esmsh]:61 62```html63<script type="module">64  import {CONTINUE, EXIT, SKIP, visit} from 'https://esm.sh/unist-util-visit@5?bundle'65</script>66```67 68## Use69 70```js71import {fromMarkdown} from 'mdast-util-from-markdown'72import {visit} from 'unist-util-visit'73 74const tree = fromMarkdown('Some *emphasis*, **strong**, and `code`.')75 76visit(tree, 'text', function (node, index, parent) {77  console.log([node.value, parent ? parent.type : index])78})79```80 81Yields:82 83```js84[ 'Some ', 'paragraph' ]85[ 'emphasis', 'emphasis' ]86[ ', ', 'paragraph' ]87[ 'strong', 'strong' ]88[ ', and ', 'paragraph' ]89[ '.', 'paragraph' ]90```91 92## API93 94This package exports the identifiers95[`CONTINUE`][api-continue],96[`EXIT`][api-exit],97[`SKIP`][api-skip], and98[`visit`][api-visit].99It exports the [TypeScript][] types100[`ActionTuple`][api-action-tuple],101[`Action`][api-action],102[`BuildVisitor`][api-build-visitor],103[`Index`][api-index],104[`Test`][api-test],105[`VisitorResult`][api-visitor-result], and106[`Visitor`][api-visitor].107There is no default export.108 109### `visit(tree[, test], visitor[, reverse])`110 111This function works exactly the same as112[`unist-util-visit-parents`][github-vp],113but [`Visitor`][api-visitor] has a different signature.114 115### `CONTINUE`116 117Continue traversing as normal (`true`).118 119### `EXIT`120 121Stop traversing immediately (`false`).122 123### `SKIP`124 125Do not traverse this node’s children (`'skip'`).126 127### `Action`128 129Union of the action types (TypeScript type).130See [`Action` in `unist-util-visit-parents`][github-vp-action].131 132### `ActionTuple`133 134List with an action and an index (TypeScript type).135See [`ActionTuple` in `unist-util-visit-parents`][github-vp-action-tuple].136 137### `BuildVisitor`138 139Build a typed `Visitor` function from a tree and a test (TypeScript type).140See [`BuildVisitor` in `unist-util-visit-parents`][github-vp-build-visitor].141 142### `Index`143 144Move to the sibling at `index` next (TypeScript type).145See [`Index` in `unist-util-visit-parents`][github-vp-index].146 147### `Test`148 149[`unist-util-is`][github-unist-util-is] compatible test150(TypeScript type).151 152### `Visitor`153 154Handle a node (matching `test`, if given) (TypeScript type).155 156Visitors are free to transform `node`.157They can also transform `parent`.158 159Replacing `node` itself, if `SKIP` is not returned, still causes its160descendants to be walked (which is a bug).161 162When adding or removing previous siblings of `node` (or next siblings, in163case of reverse), the `Visitor` should return a new `Index` to specify the164sibling to traverse after `node` is traversed.165Adding or removing next siblings of `node` (or previous siblings, in case166of reverse) is handled as expected without needing to return a new `Index`.167 168Removing the children property of `parent` still results in them being169traversed.170 171###### Parameters172 173* `node` ([`Node`][github-unist-node])174  — found node175* `index` (`number` or `undefined`)176  — index of `node` in `parent`177* `parent` ([`Node`][github-unist-node] or `undefined`)178  — parent of `node`179 180###### Returns181 182What to do next.183 184An `Index` is treated as a tuple of `[CONTINUE, Index]`.185An `Action` is treated as a tuple of `[Action]`.186 187Passing a tuple back only makes sense if the `Action` is `SKIP`.188When the `Action` is `EXIT`, that action can be returned.189When the `Action` is `CONTINUE`, `Index` can be returned.190 191### `VisitorResult`192 193Any value that can be returned from a visitor (TypeScript type).194See [`VisitorResult` in195`unist-util-visit-parents`][github-vp-visitor-result].196 197## Compatibility198 199Projects maintained by the unified collective are compatible with maintained200versions of Node.js.201 202When we cut a new major release, we drop support for unmaintained versions of203Node.204This means we try to keep the current release line, `unist-util-visit@^5`,205compatible with Node.js 16.206 207## Related208 209* [`unist-util-visit-parents`][github-vp]210  — walk the tree with a stack of parents211* [`unist-util-filter`](https://github.com/syntax-tree/unist-util-filter)212  — create a new tree with all nodes that pass a test213* [`unist-util-map`](https://github.com/syntax-tree/unist-util-map)214  — create a new tree with all nodes mapped by a given function215* [`unist-util-flatmap`](https://gitlab.com/staltz/unist-util-flatmap)216  — create a new tree by mapping (to an array) with the given function217* [`unist-util-remove`](https://github.com/syntax-tree/unist-util-remove)218  — remove nodes from a tree that pass a test219* [`unist-util-select`](https://github.com/syntax-tree/unist-util-select)220  — select nodes with CSS-like selectors221 222## Contribute223 224See [`contributing.md`][health-contributing] in [`syntax-tree/.github`][health]225for ways to get started.226See [`support.md`][health-support] for ways to get help.227 228This project has a [code of conduct][health-coc].229By interacting with this repository,230organization,231or community you agree to abide by its terms.232 233## License234 235[MIT][file-license] © [Titus Wormer][wooorm]236 237<!-- Definition -->238 239[api-action]: #action240 241[api-action-tuple]: #actiontuple242 243[api-build-visitor]: #buildvisitor244 245[api-continue]: #continue246 247[api-exit]: #exit248 249[api-index]: #index250 251[api-skip]: #skip252 253[api-test]: #test254 255[api-visit]: #visittree-test-visitor-reverse256 257[api-visitor]: #visitor258 259[api-visitor-result]: #visitorresult260 261[badge-build-image]: https://github.com/syntax-tree/unist-util-visit/workflows/main/badge.svg262 263[badge-build-url]: https://github.com/syntax-tree/unist-util-visit/actions264 265[badge-coverage-image]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-visit.svg266 267[badge-coverage-url]: https://codecov.io/github/syntax-tree/unist-util-visit268 269[badge-downloads-image]: https://img.shields.io/npm/dm/unist-util-visit.svg270 271[badge-downloads-url]: https://www.npmjs.com/package/unist-util-visit272 273[badge-size-image]: https://img.shields.io/bundlejs/size/unist-util-visit274 275[badge-size-url]: https://bundlejs.com/?q=unist-util-visit276 277[esmsh]: https://esm.sh278 279[file-license]: license280 281[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c282 283[github-unist]: https://github.com/syntax-tree/unist284 285[github-unist-node]: https://github.com/syntax-tree/unist#nodes286 287[github-unist-util-is]: https://github.com/syntax-tree/unist-util-is288 289[github-vp]: https://github.com/syntax-tree/unist-util-visit-parents290 291[github-vp-action]: https://github.com/syntax-tree/unist-util-visit-parents#action292 293[github-vp-action-tuple]: https://github.com/syntax-tree/unist-util-visit-parents#actiontuple294 295[github-vp-build-visitor]: https://github.com/syntax-tree/unist-util-visit-parents#buildvisitor296 297[github-vp-index]: https://github.com/syntax-tree/unist-util-visit-parents#index298 299[github-vp-visitor-result]: https://github.com/syntax-tree/unist-util-visit-parents#visitorresult300 301[health]: https://github.com/syntax-tree/.github302 303[health-coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md304 305[health-contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md306 307[health-support]: https://github.com/syntax-tree/.github/blob/main/support.md308 309[npmjs-install]: https://docs.npmjs.com/cli/install310 311[typescript]: https://www.typescriptlang.org312 313[wooorm]: https://wooorm.com314