mdast-util-find-and-replace

mdast utility to find and replace text in a tree

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
mdast-util-find-and-replace
502.2.14 months ago2 years agoMinified + gzip package size for mdast-util-find-and-replace in KB

Readme

mdast-util-find-and-replace
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
mdast utility to find and replace things.

Contents

*   [`findAndReplace(tree, find, replace[, options])`](#findandreplacetree-find-replace-options)

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-replacehast-util-find-and-replace does the same but on hast.

Install

This package is ESM onlyesm. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install mdast-util-find-and-replace

In Deno with esm.shesmsh:
import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@2'

In browsers with esm.shesmsh:
<script type="module">
  import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@2?bundle'
</script>

Use

import {u} from 'unist-builder'
import {inspect} from 'unist-util-inspect'
import {findAndReplace} from 'mdast-util-find-and-replace'

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 "."

API

This package exports the identifier findAndReplace. There is no default export.

findAndReplace(tree, find, replace[, options])

Find patterns in a tree and replace them. The algorithm searches the tree in preorder for complete values in Texttext nodes. Partial matches are not supported.
Signatures
  • findAndReplace(tree, find, replace[, options])
  • findAndReplace(tree, search[, options])
Parameters
— value to find and remove (`string`s are escaped and turned into a global
`RegExp`)
  • replace (string or Function)
— value to insert.
`string`s are turned into a [`Text`][text] node,
`Function`s are called with the results of calling `RegExp.exec` as
arguments, and they can return a [`Node`][node], a `string` (which is
wrapped in a [`Text`][text] node), or `false` to not replace
  • search (Array or Object)
— perform multiple find-and-replaces.
Either an `Array` of tuples (`Array`s) with `find` (at `0`) and `replace`
(at `1`), or an `Object` where each key is `find` and each value is
the corresponding `replace`
  • options.ignore (Test, default: [])
— any [`unist-util-is`][test] compatible test.
Returns
The given tree (Nodenode).

Types

This package is fully typed with TypeScript. It exports the types Find, Replace, ReplaceFunction, FindAndReplaceTuple, FindAndReplaceSchema, FindAndReplaceList, RegExpMatchObject, and Options.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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

— find and replace in hast
— `querySelector`, `querySelectorAll`, and `matches`
— select unist nodes with CSS-like selectors

Contribute

See contributing.mdcontributing in syntax-tree/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor