@kerebron/tree-sitter 0.5.5 → 0.6.1

package/esm/extended/parser.js

@@ -0,0 +1,61 @@
+// import { Tree } from "../web-tree-sitter/src/tree.ts"
+// import { ParseOptions, Parser } from "../web-tree-sitter/src/parser.ts"
+// import { Language } from "../web-tree-sitter/src/language.ts"
+// import { ParseCallback } from "../web-tree-sitter/src/index.ts";
+// import { setModule } from '../web-tree-sitter/src/constants.ts';
+// import { MainModule } from '../web-tree-sitter/lib/web-tree-sitter.d.ts';
+import './node_extended.js';
+import { Language, Parser, } from 'web-tree-sitter';
+// this only exists to help with type hints
+class ExtendedParser extends Parser {
+    disableSoftNodes = false;
+    /**
+     * Parse a slice of UTF8 text.
+     *
+     * @param {string | ParseCallback} callback - Source code to parse
+     *
+     * @param {Tree | null} [oldTree] - A previous syntax tree parsed from the same document. If the text of the
+     *   document has changed since `oldTree` was created, then you must edit `oldTree` to match
+     *   the new text using {@link Tree#edit}.
+     *
+     * @param {ParseOptions} [options] - Options for parsing the text.
+     *  This can be used to set the included ranges, or a progress callback.
+     *
+     * @returns {ExtendedTree | null} A {@link Tree} if parsing succeeded, or `null` if:
+     *  - The parser has not yet had a language assigned with {@link Parser#setLanguage}.
+     *  - The progress callback returned true.
+     */
+    parse(code, oldTree, options) {
+        if (typeof code == 'function') {
+            console.warn("When calling .parse() the source code was a function instead of a string. The original tree sitter supports giving a function as a means of supporting edits (see: https://github.com/tree-sitter/tree-sitter/discussions/2553 ).\nHowever, this library supports edits directly (use node.replaceInnards(``))\nThe downside of making edits easy is that .parse() doesn't really accept a function argument. I'm just going to evaluate that function to grab the string once at the beginning. Use tree.codeString if you want to get the full string after a .replaceInnards() call.");
+            code = code(0, { row: 0, column: 0 }) || '';
+        }
+        // if (!checkModule()) {
+        //   throw new Error("cannot construct a Parser before calling `init()`");
+        // }
+        let tree = null;
+        tree = super.parse.apply(this, [
+            (index) => (tree?.codeString ?? code).slice(index),
+            oldTree,
+            options,
+        ]);
+        tree.codeString = code;
+        tree._enableSoftNodes = !this.disableSoftNodes;
+        return tree;
+    }
+}
+const langCache = new Map();
+let hasBeenLoaded = false;
+export async function createParser(wasmUint8Array, { disableSoftNodes = false, moduleOptions } = {}) {
+    await Parser.init();
+    if (!hasBeenLoaded) {
+        hasBeenLoaded = true;
+        await Parser.init(moduleOptions);
+    }
+    const parser = new ExtendedParser();
+    const language = await Language.load(wasmUint8Array);
+    parser.setLanguage(language);
+    parser.disableSoftNodes = disableSoftNodes;
+    return parser;
+}
+//# sourceMappingURL=parser.js.map

package/esm/extended/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/extended/parser.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,0EAA0E;AAC1E,gEAAgE;AAChE,mEAAmE;AACnE,mEAAmE;AACnE,4EAA4E;AAC5E,OAAO,oBAAoB,CAAC;AAC5B,OAAO,EACL,QAAQ,EAGR,MAAM,GAEP,MAAM,iBAAiB,CAAC;AAEzB,2CAA2C;AAC3C,MAAM,cAAe,SAAQ,MAAM;IACjC,gBAAgB,GAAG,KAAK,CAAC;IAEzB;;;;;;;;;;;;;;;OAeG;IACM,KAAK,CACZ,IAA4B,EAC5B,OAAoB,EACpB,OAAqB;QAErB,IAAI,OAAO,IAAI,IAAI,UAAU,EAAE,CAAC;YAC9B,OAAO,CAAC,IAAI,CACV,yjBAAyjB,CAC1jB,CAAC;YACF,IAAI,GAAG,IAAI,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;QAC9C,CAAC;QACD,wBAAwB;QACxB,0EAA0E;QAC1E,IAAI;QAEJ,IAAI,IAAI,GAAgB,IAAI,CAAC;QAC7B,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;YAC7B,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,UAAU,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;YAC1D,OAAO;YACP,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,gBAAgB,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;AAC5B,IAAI,aAAa,GAAG,KAAK,CAAC;AAgB1B,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,cAA0B,EAC1B,EAAE,gBAAgB,GAAG,KAAK,EAAE,aAAa,KAAc,EAAE;IAEzD,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;IAEpB,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,aAAa,GAAG,IAAI,CAAC;QACrB,MAAM,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;IACpC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACrD,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC7B,MAAM,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/esm/{deno-tree-sitter/main/extended → extended}/soft_node.d.ts

@@ -1,5 +1,7 @@
-export class SoftNode extends BaseNode {
-    children: any[];
+import { BaseNode } from './base_node.js';
+export declare class SoftNode extends BaseNode {
+    children: never[];
+    constructor(data: any);
     get startIndex(): any;
     get startPosition(): {
         row: any;
@@ -11,5 +13,4 @@ export class SoftNode extends BaseNode {
         column: any;
     };
 }
-import { BaseNode } from "./base_node.js";
 //# sourceMappingURL=soft_node.d.ts.map

package/esm/extended/soft_node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"soft_node.d.ts","sourceRoot":"","sources":["../../src/extended/soft_node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C,qBAAa,QAAS,SAAQ,QAAQ;IACpC,QAAQ,UAAM;gBACF,IAAI,KAAA;IAKhB,IAAI,UAAU,QAEb;IAED,IAAI,aAAa;;;MAKhB;IAED,IAAI,QAAQ,QAEX;IAED,IAAI,WAAW;;;MAKd;CACF"}

package/esm/{deno-tree-sitter/main/extended → extended}/soft_node.js

@@ -1,4 +1,4 @@
-import { BaseNode } from "./base_node.js";
+import { BaseNode } from './base_node.js';
 // HardNode extends BaseNode as well (indirectly)
 export class SoftNode extends BaseNode {
     children = [];

package/esm/extended/soft_node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"soft_node.js","sourceRoot":"","sources":["../../src/extended/soft_node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,iDAAiD;AACjD,MAAM,OAAO,QAAS,SAAQ,QAAQ;IACpC,QAAQ,GAAG,EAAE,CAAC;IACd,YAAY,IAAI;QACd,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAED,uKAAuK;IACvK,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC;IACjE,CAAC;IAED,IAAI,aAAa;QACf,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,GAAG;YACjE,MAAM,EAAE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,MAAM;SACxE,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC;IAC/D,CAAC;IAED,IAAI,WAAW;QACb,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,GAAG;YAC/D,MAAM,EAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,MAAM;SACtE,CAAC;IACJ,CAAC;CACF"}

package/esm/extended/soft_text_node.d.ts

@@ -0,0 +1,9 @@
+import { SoftNode } from './soft_node.js';
+export declare class SoftTextNode extends SoftNode {
+    constructor({ parent, ...data }: {
+        [x: string]: any;
+        parent: any;
+    });
+    get parent(): any;
+}
+//# sourceMappingURL=soft_text_node.d.ts.map

package/esm/extended/soft_text_node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"soft_text_node.d.ts","sourceRoot":"","sources":["../../src/extended/soft_text_node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,qBAAa,YAAa,SAAQ,QAAQ;gBAC5B,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE;;;KAAA;IAI/B,IAAI,MAAM,QAET;CACF"}

package/esm/{deno-tree-sitter/main/extended → extended}/soft_text_node.js

@@ -1,7 +1,7 @@
-import { SoftNode } from "./soft_node.js";
+import { SoftNode } from './soft_node.js';
 export class SoftTextNode extends SoftNode {
     constructor({ parent, ...data }) {
-        super({ ...data, type: "text", typeId: -2 });
+        super({ ...data, type: 'text', typeId: -2 });
         this._parent = parent;
     }
     get parent() {

package/esm/extended/soft_text_node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"soft_text_node.js","sourceRoot":"","sources":["../../src/extended/soft_text_node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,OAAO,YAAa,SAAQ,QAAQ;IACxC,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE;QAC7B,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IACD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF"}

package/esm/extended/whitespace_node.d.ts

@@ -0,0 +1,9 @@
+import { SoftNode } from './soft_node.js';
+export declare class WhitespaceNode extends SoftNode {
+    constructor({ parent, ...data }: {
+        [x: string]: any;
+        parent: any;
+    });
+    get parent(): any;
+}
+//# sourceMappingURL=whitespace_node.d.ts.map

package/esm/extended/whitespace_node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"whitespace_node.d.ts","sourceRoot":"","sources":["../../src/extended/whitespace_node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,qBAAa,cAAe,SAAQ,QAAQ;gBAC9B,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE;;;KAAA;IAI/B,IAAI,MAAM,QAET;CACF"}

package/esm/{deno-tree-sitter/main/extended → extended}/whitespace_node.js

@@ -1,7 +1,7 @@
-import { SoftNode } from "./soft_node.js";
+import { SoftNode } from './soft_node.js';
 export class WhitespaceNode extends SoftNode {
     constructor({ parent, ...data }) {
-        super({ ...data, type: "whitespace", typeId: -1 });
+        super({ ...data, type: 'whitespace', typeId: -1 });
         this._parent = parent;
     }
     get parent() {

package/esm/extended/whitespace_node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whitespace_node.js","sourceRoot":"","sources":["../../src/extended/whitespace_node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,OAAO,cAAe,SAAQ,QAAQ;IAC1C,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE;QAC7B,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IACD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF"}

package/esm/extras/misc.d.ts

@@ -0,0 +1,2 @@
+export declare function _getQueryCaptureTargets(queryString: any): any;
+//# sourceMappingURL=misc.d.ts.map

package/esm/extras/misc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"misc.d.ts","sourceRoot":"","sources":["../../src/extras/misc.ts"],"names":[],"mappings":"AAAA,wBAAgB,uBAAuB,CAAC,WAAW,KAAA,OAclD"}

package/esm/{deno-tree-sitter/main/extras → extras}/misc.js

@@ -1,11 +1,11 @@
 export function _getQueryCaptureTargets(queryString) {
-    if (!queryString.includes("@")) {
+    if (!queryString.includes('@')) {
         return [];
     }
     else { // need a rigorous check
         // remove all strings from within the query (the only place a false capture target could appear)
         // NOTE: this is based exactly on the language spec, its not a hack: https://github.com/tree-sitter-grammars/tree-sitter-query/blob/3a9808b22742d5bd906ef5d1a562f2f1ae57406d/src/grammar.json#L140
-        const safeSearchableQuery = queryString.replace(/"(?:\\(?:[^xu0-7]|[0-7]{1,3}|x[0-9a-fA-F]{2}|u[0-9a-fA-F]{4}|u{[0-9a-fA-F]+})|[^\"\\])*"/g, "");
+        const safeSearchableQuery = queryString.replace(/"(?:\\(?:[^xu0-7]|[0-7]{1,3}|x[0-9a-fA-F]{2}|u[0-9a-fA-F]{4}|u{[0-9a-fA-F]+})|[^\"\\])*"/g, '');
         // now check if there is a capture target
         // NOTE: also based on the language spec: https://github.com/tree-sitter-grammars/tree-sitter-query/blob/3a9808b22742d5bd906ef5d1a562f2f1ae57406d/src/grammar.json#L204
         return safeSearchableQuery.match(/(?<=@)([a-zA-Z0-9.\-_\$]+)/g);

package/esm/extras/misc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"misc.js","sourceRoot":"","sources":["../../src/extras/misc.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,uBAAuB,CAAC,WAAW;IACjD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,CAAC;IACZ,CAAC;SAAM,CAAC,CAAC,wBAAwB;QAC/B,gGAAgG;QAChG,kMAAkM;QAClM,MAAM,mBAAmB,GAAG,WAAW,CAAC,OAAO,CAC7C,2FAA2F,EAC3F,EAAE,CACH,CAAC;QACF,yCAAyC;QACzC,uKAAuK;QACvK,OAAO,mBAAmB,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAClE,CAAC;AACH,CAAC"}

package/esm/mod.d.ts

@@ -1,7 +1,2 @@
-export { createParser } from './deno-tree-sitter/main/extended/parser.js';
-export { Parser } from './deno-tree-sitter/main/tree_sitter/parser.js';
-export { Language } from './deno-tree-sitter/main/tree_sitter/language.js';
-export { Query } from './deno-tree-sitter/main/tree_sitter/query.js';
-export { Node } from './deno-tree-sitter/main/tree_sitter/node.js';
-export { Tree } from './deno-tree-sitter/main/tree_sitter/tree.js';
+export { createParser } from './extended/parser.js';
 //# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,+CAA+C,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,iDAAiD,CAAC;AAC3E,OAAO,EAAE,KAAK,EAAE,MAAM,8CAA8C,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,MAAM,6CAA6C,CAAC;AACnE,OAAO,EAAE,IAAI,EAAE,MAAM,6CAA6C,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC"}

package/esm/mod.js

@@ -1,8 +1,2 @@
-// JS files exported because of sloppy-imports
-export { createParser } from './deno-tree-sitter/main/extended/parser.js';
-export { Parser } from './deno-tree-sitter/main/tree_sitter/parser.js';
-export { Language } from './deno-tree-sitter/main/tree_sitter/language.js';
-export { Query } from './deno-tree-sitter/main/tree_sitter/query.js';
-export { Node } from './deno-tree-sitter/main/tree_sitter/node.js';
-export { Tree } from './deno-tree-sitter/main/tree_sitter/tree.js';
+export { createParser } from './extended/parser.js';
 //# sourceMappingURL=mod.js.map

package/esm/mod.js.map

@@ -1 +1 @@
-{"version":3,"file":"mod.js","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAE9C,OAAO,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,+CAA+C,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,iDAAiD,CAAC;AAC3E,OAAO,EAAE,KAAK,EAAE,MAAM,8CAA8C,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,MAAM,6CAA6C,CAAC;AACnE,OAAO,EAAE,IAAI,EAAE,MAAM,6CAA6C,CAAC"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kerebron/tree-sitter",
-  "version": "0.5.5",
+  "version": "0.6.1",
   "license": "MIT",
   "module": "./esm/mod.js",
   "exports": {
@@ -13,6 +13,9 @@
     "esm",
     "src"
   ],
+  "dependencies": {
+    "web-tree-sitter": "0.26.6"
+  },
   "devDependencies": {
     "@types/node": "^20.9.0"
   },

package/src/extended/base_node.ts

@@ -0,0 +1,175 @@
+import { Node } from 'web-tree-sitter';
+
+export const _shadows = {};
+export class BaseNode {
+  // type = ""
+  // typeId = 0
+  // startPosition = 0
+  // startIndex = 0
+  // endPosition = 0
+  // startIndex = 0
+  // endIndex = 0
+  // indent = ""
+
+  constructor(data) {
+    Object.assign(this, data);
+  }
+
+  /** @type {number} */
+  get depth() {
+    if (this._depth == null) {
+      if (this.parent == null) {
+        this._depth = 0;
+      } else {
+        this._depth = this.parent.depth + 1;
+      }
+    }
+    return this._depth;
+  }
+
+  /** @type {number} */
+  get length() {
+    return this.children?.length || 0;
+  }
+
+  *[Symbol.iterator]() {
+    yield* this.children || [];
+  }
+
+  get hasChildren() {
+    return (this.children?.length || 0) > 0;
+  }
+
+  get hardChildren() {
+    return (this.children || []).filter((each) => each instanceof Node);
+  }
+
+  get fields() {
+    return {};
+  }
+
+  get fieldNames() {
+    return [];
+  }
+
+  /** @type {string} */
+  get indent() {
+    return this.tree.codeString.match(
+      new RegExp(`^(?:.*\\r?\\n){${this.startPosition.row}}(\\s*)`),
+    )[1];
+    // equivalent but usually faster than:
+    // return this.tree.codeString.split("\n")[this.startPosition.row].match(/^\s*/)[0]
+  }
+
+  /** @type {Object} */
+  toJSON() {
+    const optionalData = {};
+    if (this.children?.length) {
+      return {
+        type: this.type,
+        typeId: this.typeId,
+        fieldNames: this.fieldNames,
+        startPosition: this.startPosition,
+        startIndex: this.startIndex,
+        endPosition: this.endPosition,
+        indent: this.indent,
+        ...optionalData,
+        children: this.children.map((each) => each.toJSON()),
+      };
+    } else {
+      return {
+        type: this.type,
+        typeId: this.typeId,
+        fieldNames: this.fieldNames,
+        startPosition: this.startPosition,
+        startIndex: this.startIndex,
+        endPosition: this.endPosition,
+        indent: this.indent,
+        ...optionalData,
+        text: this.text,
+        children: [],
+      };
+    }
+  }
+
+  [Symbol.for('Deno.customInspect')](inspect, options) {
+    const optional = {};
+    let text;
+    try {
+      text = this.text;
+    } catch (error) {
+      text = undefined;
+    }
+    if (text == undefined) {
+      return this;
+    }
+    return inspect(
+      {
+        '': text.length < 60
+          ? text
+          : text.slice(0, 30) + '...' + text.slice(-27),
+        type: this.type,
+        typeId: this.typeId,
+        fieldNames: this.fieldNames,
+        startPosition: this.startPosition,
+        startIndex: this.startIndex,
+        endPosition: this.endPosition,
+        indent: this.indent,
+        ...optional,
+        hasChildren: this.hasChildren,
+        children: [...(this.children || [])],
+      },
+      options,
+    );
+  }
+  *iterFlattened() {
+  }
+  flattened() {
+    return [];
+  }
+
+  /**
+   * Destroy the children of this node and replace the .text of this node with the given string.
+   *
+   * @param {string} replacement - description
+   */
+  replaceInnards(replacement) {
+    const tree = this.tree;
+    const sourceCode = this.tree.codeString;
+    const node = _shadows[this.id] || this;
+    // clear out children (innards) because of replacement
+    node._children = [];
+    node._fields = {};
+    // get the node position info
+    const {
+      startPosition: originalStart,
+      endPosition: originalEnd,
+      startIndex: originalStartIndex,
+      endIndex: originalEndIndex,
+    } = node;
+
+    // compute what the new row-column will be
+    const newNumberOfLines = replacement.match(/\n/g)?.length || 0;
+    let newEndCol = originalStart.column;
+    if (newNumberOfLines == 0) {
+      newEndCol = originalStart.column + replacement.length;
+    } else {
+      newEndCol = replacement.split('\n').slice(-1)[0].length;
+    }
+    // updates all the indices of all the nodes
+    tree.edit({
+      startIndex: originalStartIndex,
+      oldEndIndex: originalEndIndex,
+      newEndIndex: originalStartIndex + replacement.length,
+      startPosition: originalStart,
+      oldEndPosition: originalEnd,
+      newEndPosition: {
+        row: originalStart.row + newNumberOfLines,
+        column: newEndCol,
+      },
+    });
+
+    this.tree.codeString = sourceCode.slice(0, originalStartIndex) +
+      replacement + sourceCode.slice(originalEndIndex);
+  }
+}