Add stack of nodes in match objects

Author: wooorm

index.js

@@ -3,6 +3,7 @@
  * @typedef {import('./lib/index.js').Find} Find
  * @typedef {import('./lib/index.js').Replace} Replace
  * @typedef {import('./lib/index.js').ReplaceFunction} ReplaceFunction
+ * @typedef {import('./lib/index.js').RegExpMatchObject} RegExpMatchObject
  * @typedef {import('./lib/index.js').FindAndReplaceTuple} FindAndReplaceTuple
  * @typedef {import('./lib/index.js').FindAndReplaceSchema} FindAndReplaceSchema
  * @typedef {import('./lib/index.js').FindAndReplaceList} FindAndReplaceList

lib/index.js

@@ -12,6 +12,11 @@
  * @typedef {import('hast-util-is-element').Test} Test
  * @typedef {import('unist-util-visit-parents').VisitorResult} VisitorResult
  *
+ * @typedef RegExpMatchObject
+ * @property {number} index
+ * @property {string} input
+ * @property {[Root, ...Array<Element>, Text]} stack
+ *
  * @typedef {string|RegExp} Find
  * @typedef {string|ReplaceFunction} Replace
  *
@@ -97,16 +102,17 @@ export function findAndReplace(tree, find, replace, options) {
     }
 
     if (grandparent) {
-      return handler(node, grandparent)
+      return handler(node, parents)
     }
   }
 
   /**
    * @param {Text} node
-   * @param {Parent} parent
+   * @param {Array<Root|Element>} parents
    * @returns {VisitorResult}
    */
-  function handler(node, parent) {
+  function handler(node, parents) {
+    const parent = parents[parents.length - 1]
     const find = pairs[pairIndex][0]
     const replace = pairs[pairIndex][1]
     let start = 0
@@ -122,7 +128,14 @@ export function findAndReplace(tree, find, replace, options) {
 
     while (match) {
       position = match.index
-      let value = replace(...match, {index: match.index, input: match.input})
+      /** @type {RegExpMatchObject} */
+      const matchObject = {
+        index: match.index,
+        input: match.input,
+        // @ts-expect-error: stack is fine.
+        stack: [...parents, node]
+      }
+      let value = replace(...match, matchObject)
 
       if (typeof value === 'string') {
         value = value.length > 0 ? {type: 'text', value} : undefined

readme.md

@@ -163,8 +163,8 @@ The given `tree` ([`Node`][node]).
 
 This package is fully typed with [TypeScript][].
 It exports the additional types `Find`, `Replace`, `ReplaceFunction`,
-`FindAndReplaceTuple`, `FindAndReplaceSchema`, `FindAndReplaceList`, and
-`Options`.
+`FindAndReplaceTuple`, `FindAndReplaceSchema`, `FindAndReplaceList`,
+`RegExpMatchObject`, and `Options`.
 
 ## Compatibility