8839075805
Implements Phases 1-8 of the TFTSR implementation plan. Rust backend (Tauri 2.x, src-tauri/): - Multi-provider AI: OpenAI-compatible, Anthropic, Gemini, Mistral, Ollama - PII detection engine: 11 regex patterns with overlap resolution - SQLCipher AES-256 encrypted database with 10 versioned migrations - 28 Tauri IPC commands for triage, analysis, document, and system ops - Ollama: hardware probe, model recommendations, pull/delete with events - RCA and blameless post-mortem Markdown document generators - PDF export via printpdf - Audit log: SHA-256 hash of every external data send - Integration stubs for Confluence, ServiceNow, Azure DevOps (v0.2) Frontend (React 18 + TypeScript + Vite, src/): - 9 pages: full triage workflow NewIssue→LogUpload→Triage→Resolution→RCA→Postmortem→History+Settings - 7 components: ChatWindow, TriageProgress, PiiDiffViewer, DocEditor, HardwareReport, ModelSelector, UI primitives - 3 Zustand stores: session, settings (persisted), history - Type-safe tauriCommands.ts matching Rust backend types exactly - 8 IT domain system prompts (Linux, Windows, Network, K8s, DB, Virt, HW, Obs) DevOps: - .woodpecker/test.yml: rustfmt, clippy, cargo test, tsc, vitest on every push - .woodpecker/release.yml: linux/amd64 + linux/arm64 builds, Gogs release upload Verified: - cargo check: zero errors - tsc --noEmit: zero errors - vitest run: 13/13 unit tests passing Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
369 lines
9.0 KiB
Markdown
369 lines
9.0 KiB
Markdown
# mdast-util-find-and-replace
|
|
|
|
[![Build][build-badge]][build]
|
|
[![Coverage][coverage-badge]][coverage]
|
|
[![Downloads][downloads-badge]][downloads]
|
|
[![Size][size-badge]][size]
|
|
[![Sponsors][sponsors-badge]][collective]
|
|
[![Backers][backers-badge]][collective]
|
|
[![Chat][chat-badge]][chat]
|
|
|
|
[mdast][] utility to find and replace things.
|
|
|
|
## Contents
|
|
|
|
* [What is this?](#what-is-this)
|
|
* [When should I use this?](#when-should-i-use-this)
|
|
* [Install](#install)
|
|
* [Use](#use)
|
|
* [API](#api)
|
|
* [`findAndReplace(tree, list[, options])`](#findandreplacetree-list-options)
|
|
* [`Find`](#find)
|
|
* [`FindAndReplaceList`](#findandreplacelist)
|
|
* [`FindAndReplaceTuple`](#findandreplacetuple)
|
|
* [`Options`](#options)
|
|
* [`RegExpMatchObject`](#regexpmatchobject)
|
|
* [`Replace`](#replace)
|
|
* [`ReplaceFunction`](#replacefunction)
|
|
* [Types](#types)
|
|
* [Compatibility](#compatibility)
|
|
* [Security](#security)
|
|
* [Related](#related)
|
|
* [Contribute](#contribute)
|
|
* [License](#license)
|
|
|
|
## What is this?
|
|
|
|
This package is a utility that lets you find patterns (`string`, `RegExp`) in
|
|
text and replace them with nodes.
|
|
|
|
## When should I use this?
|
|
|
|
This utility is typically useful when you have regexes and want to modify mdast.
|
|
One example is when you have some form of “mentions” (such as
|
|
`/@([a-z][_a-z0-9])\b/gi`) and want to create links to persons from them.
|
|
|
|
A similar package, [`hast-util-find-and-replace`][hast-util-find-and-replace]
|
|
does the same but on [hast][].
|
|
|
|
## Install
|
|
|
|
This package is [ESM only][esm].
|
|
In Node.js (version 16+), install with [npm][]:
|
|
|
|
```sh
|
|
npm install mdast-util-find-and-replace
|
|
```
|
|
|
|
In Deno with [`esm.sh`][esmsh]:
|
|
|
|
```js
|
|
import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@3'
|
|
```
|
|
|
|
In browsers with [`esm.sh`][esmsh]:
|
|
|
|
```html
|
|
<script type="module">
|
|
import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@3?bundle'
|
|
</script>
|
|
```
|
|
|
|
## Use
|
|
|
|
```js
|
|
import {findAndReplace} from 'mdast-util-find-and-replace'
|
|
import {u} from 'unist-builder'
|
|
import {inspect} from 'unist-util-inspect'
|
|
|
|
const tree = u('paragraph', [
|
|
u('text', 'Some '),
|
|
u('emphasis', [u('text', 'emphasis')]),
|
|
u('text', ' and '),
|
|
u('strong', [u('text', 'importance')]),
|
|
u('text', '.')
|
|
])
|
|
|
|
findAndReplace(tree, [
|
|
[/and/gi, 'or'],
|
|
[/emphasis/gi, 'em'],
|
|
[/importance/gi, 'strong'],
|
|
[
|
|
/Some/g,
|
|
function ($0) {
|
|
return u('link', {url: '//example.com#' + $0}, [u('text', $0)])
|
|
}
|
|
]
|
|
])
|
|
|
|
console.log(inspect(tree))
|
|
```
|
|
|
|
Yields:
|
|
|
|
```txt
|
|
paragraph[8]
|
|
├─0 link[1]
|
|
│ │ url: "//example.com#Some"
|
|
│ └─0 text "Some"
|
|
├─1 text " "
|
|
├─2 emphasis[1]
|
|
│ └─0 text "em"
|
|
├─3 text " "
|
|
├─4 text "or"
|
|
├─5 text " "
|
|
├─6 strong[1]
|
|
│ └─0 text "strong"
|
|
└─7 text "."
|
|
```
|
|
|
|
## API
|
|
|
|
This package exports the identifier [`findAndReplace`][api-find-and-replace].
|
|
There is no default export.
|
|
|
|
### `findAndReplace(tree, list[, options])`
|
|
|
|
Find patterns in a tree and replace them.
|
|
|
|
The algorithm searches the tree in *[preorder][]* for complete values in
|
|
[`Text`][text] nodes.
|
|
Partial matches are not supported.
|
|
|
|
###### Parameters
|
|
|
|
* `tree` ([`Node`][node])
|
|
— tree to change
|
|
* `list` ([`FindAndReplaceList`][api-find-and-replace-list] or
|
|
[`FindAndReplaceTuple`][api-find-and-replace-tuple])
|
|
— one or more find-and-replace pairs
|
|
* `options` ([`Options`][api-options])
|
|
— configuration
|
|
|
|
###### Returns
|
|
|
|
Nothing (`undefined`).
|
|
|
|
### `Find`
|
|
|
|
Pattern to find (TypeScript type).
|
|
|
|
Strings are escaped and then turned into global expressions.
|
|
|
|
###### Type
|
|
|
|
```ts
|
|
type Find = RegExp | string
|
|
```
|
|
|
|
### `FindAndReplaceList`
|
|
|
|
Several find and replaces, in array form (TypeScript type).
|
|
|
|
###### Type
|
|
|
|
```ts
|
|
type FindAndReplaceList = Array<FindAndReplaceTuple>
|
|
```
|
|
|
|
See [`FindAndReplaceTuple`][api-find-and-replace-tuple].
|
|
|
|
### `FindAndReplaceTuple`
|
|
|
|
Find and replace in tuple form (TypeScript type).
|
|
|
|
###### Type
|
|
|
|
```ts
|
|
type FindAndReplaceTuple = [Find, Replace?]
|
|
```
|
|
|
|
See [`Find`][api-find] and [`Replace`][api-replace].
|
|
|
|
### `Options`
|
|
|
|
Configuration (TypeScript type).
|
|
|
|
###### Fields
|
|
|
|
* `ignore` ([`Test`][test], optional)
|
|
— test for which elements to ignore
|
|
|
|
### `RegExpMatchObject`
|
|
|
|
Info on the match (TypeScript type).
|
|
|
|
###### Fields
|
|
|
|
* `index` (`number`)
|
|
— the index of the search at which the result was found
|
|
* `input` (`string`)
|
|
— a copy of the search string in the text node
|
|
* `stack` ([`Array<Node>`][node])
|
|
— all ancestors of the text node, where the last node is the text itself
|
|
|
|
### `Replace`
|
|
|
|
Thing to replace with (TypeScript type).
|
|
|
|
###### Type
|
|
|
|
```ts
|
|
type Replace = ReplaceFunction | string
|
|
```
|
|
|
|
See [`ReplaceFunction`][api-replace-function].
|
|
|
|
### `ReplaceFunction`
|
|
|
|
Callback called when a search matches (TypeScript type).
|
|
|
|
###### Parameters
|
|
|
|
The parameters are the result of corresponding search expression:
|
|
|
|
* `value` (`string`)
|
|
— whole match
|
|
* `...capture` (`Array<string>`)
|
|
— matches from regex capture groups
|
|
* `match` ([`RegExpMatchObject`][api-regexp-match-object])
|
|
— info on the match
|
|
|
|
###### Returns
|
|
|
|
Thing to replace with:
|
|
|
|
* when `null`, `undefined`, `''`, remove the match
|
|
* …or when `false`, do not replace at all
|
|
* …or when `string`, replace with a text node of that value
|
|
* …or when `Node` or `Array<Node>`, replace with those nodes
|
|
|
|
## Types
|
|
|
|
This package is fully typed with [TypeScript][].
|
|
It exports the additional types [`Find`][api-find],
|
|
[`FindAndReplaceList`][api-find-and-replace-list],
|
|
[`FindAndReplaceTuple`][api-find-and-replace-tuple],
|
|
[`Options`][api-options],
|
|
[`RegExpMatchObject`][api-regexp-match-object],
|
|
[`Replace`][api-replace], and
|
|
[`ReplaceFunction`][api-replace-function].
|
|
|
|
## Compatibility
|
|
|
|
Projects maintained by the unified collective are compatible with maintained
|
|
versions of Node.js.
|
|
|
|
When we cut a new major release, we drop support for unmaintained versions of
|
|
Node.
|
|
This means we try to keep the current release line,
|
|
`mdast-util-find-and-replace@^3`, compatible with Node.js 16.
|
|
|
|
## Security
|
|
|
|
Use of `mdast-util-find-and-replace` does not involve [hast][] or user content
|
|
so there are no openings for [cross-site scripting (XSS)][xss] attacks.
|
|
|
|
## Related
|
|
|
|
* [`hast-util-find-and-replace`](https://github.com/syntax-tree/hast-util-find-and-replace)
|
|
— find and replace in hast
|
|
* [`hast-util-select`](https://github.com/syntax-tree/hast-util-select)
|
|
— `querySelector`, `querySelectorAll`, and `matches`
|
|
* [`unist-util-select`](https://github.com/syntax-tree/unist-util-select)
|
|
— select unist nodes with CSS-like selectors
|
|
|
|
## Contribute
|
|
|
|
See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
|
|
ways to get started.
|
|
See [`support.md`][support] for ways to get help.
|
|
|
|
This project 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]
|
|
|
|
<!-- Definition -->
|
|
|
|
[build-badge]: https://github.com/syntax-tree/mdast-util-find-and-replace/workflows/main/badge.svg
|
|
|
|
[build]: https://github.com/syntax-tree/mdast-util-find-and-replace/actions
|
|
|
|
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-find-and-replace.svg
|
|
|
|
[coverage]: https://codecov.io/github/syntax-tree/mdast-util-find-and-replace
|
|
|
|
[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-find-and-replace.svg
|
|
|
|
[downloads]: https://www.npmjs.com/package/mdast-util-find-and-replace
|
|
|
|
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-find-and-replace
|
|
|
|
[size]: https://bundlejs.com/?q=mdast-util-find-and-replace
|
|
|
|
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
|
|
|
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
|
|
|
[collective]: https://opencollective.com/unified
|
|
|
|
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
|
|
|
[chat]: https://github.com/syntax-tree/unist/discussions
|
|
|
|
[npm]: https://docs.npmjs.com/cli/install
|
|
|
|
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
|
|
|
[esmsh]: https://esm.sh
|
|
|
|
[typescript]: https://www.typescriptlang.org
|
|
|
|
[license]: license
|
|
|
|
[author]: https://wooorm.com
|
|
|
|
[health]: https://github.com/syntax-tree/.github
|
|
|
|
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
|
|
|
|
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
|
|
|
|
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
|
|
|
|
[hast]: https://github.com/syntax-tree/hast
|
|
|
|
[mdast]: https://github.com/syntax-tree/mdast
|
|
|
|
[node]: https://github.com/syntax-tree/mdast#nodes
|
|
|
|
[preorder]: https://github.com/syntax-tree/unist#preorder
|
|
|
|
[text]: https://github.com/syntax-tree/mdast#text
|
|
|
|
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
|
|
|
|
[test]: https://github.com/syntax-tree/unist-util-is#api
|
|
|
|
[hast-util-find-and-replace]: https://github.com/syntax-tree/hast-util-find-and-replace
|
|
|
|
[api-find-and-replace]: #findandreplacetree-list-options
|
|
|
|
[api-options]: #options
|
|
|
|
[api-find]: #find
|
|
|
|
[api-replace]: #replace
|
|
|
|
[api-replace-function]: #replacefunction
|
|
|
|
[api-find-and-replace-list]: #findandreplacelist
|
|
|
|
[api-find-and-replace-tuple]: #findandreplacetuple
|
|
|
|
[api-regexp-match-object]: #regexpmatchobject
|