mdast utility to find and replace things.
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
This package is a utility that lets you find patterns (string, RegExp) in
text and replace them with nodes.
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
does the same but on hast.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install mdast-util-find-and-replaceIn Deno with esm.sh:
import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@3'In browsers with esm.sh:
<script type="module">
import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@3?bundle'
</script>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:
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 "."This package exports the identifier findAndReplace.
There is no default export.
Find patterns in a tree and replace them.
The algorithm searches the tree in preorder for complete values in
Text nodes.
Partial matches are not supported.
tree(Node) — tree to changelist(FindAndReplaceListorFindAndReplaceTuple) — one or more find-and-replace pairsoptions(Options) — configuration
Nothing (undefined).
Pattern to find (TypeScript type).
Strings are escaped and then turned into global expressions.
type Find = RegExp | stringSeveral find and replaces, in array form (TypeScript type).
type FindAndReplaceList = Array<FindAndReplaceTuple>See FindAndReplaceTuple.
Find and replace in tuple form (TypeScript type).
