@openrewrite/rewrite 8.96.4 → 8.96.5

package/dist/test/accumulator-contents.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccumulatorContents = void 0;
+/*
+ * Copyright 2025 the original author or authors.
+ * <p>
+ * Licensed under the Moderne Source Available License (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://docs.moderne.io/licensing/moderne-source-available-license
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const util_1 = require("util");
+const recipe_1 = require("../recipe");
+const tree_1 = require("../tree");
+const heavyweight_1 = require("../heavyweight");
+const java_1 = require("../java");
+const probes_1 = require("./probes");
+/** Beyond this many objects in one accumulator the walk stops descending. */
+const MAX_OBJECTS = 100000;
+const MAX_PATHS = 5;
+/**
+ * Finds the heavyweight objects that ScanningRecipe accumulators keep, which are trees and the types
+ * registerHeavyweight registers. An accumulator lives from the first source file scanned until the cycle ends. The
+ * walk reads data properties and built-in collections, and runs no code of the recipe's own.
+ */
+class AccumulatorContents {
+    constructor() {
+        /** What each recipe's accumulator keeps, by recipe name and then by the shape of the path to it. */
+        this.findings = new Map();
+        this.listener = (accumulators, phase) => {
+            const walked = new Set();
+            for (const [recipe, acc] of accumulators) {
+                if (acc !== null && typeof acc === "object" && !walked.has(acc)) {
+                    walked.add(acc);
+                    try {
+                        this.walk(recipe.name, acc, phase);
+                    }
+                    catch (_a) {
+                        // an accumulator the walk can't read is left alone
+                    }
+                }
+            }
+        };
+    }
+    assertNoneFound() {
+        if (this.findings.size === 0) {
+            return;
+        }
+        const lines = ["A ScanningRecipe's accumulator should keep the values the recipe needs, such as package " +
+                "names, versions, paths and ids, and no heavyweight objects, such as trees, cursors, visitors, execution " +
+                "contexts and dependency models:"];
+        for (const [recipe, found] of this.findings) {
+            lines.push(`  ${recipe} keeps`);
+            const shown = [...found.values()].slice(0, MAX_PATHS);
+            lines.push(...shown.map(f => `    ${f.path} -> ${f.what}, ${f.phase}`));
+            if (found.size > MAX_PATHS) {
+                lines.push(`    and ${found.size - MAX_PATHS} more`);
+            }
+        }
+        lines.push("An accumulator stays in memory from the first source file scanned until the cycle ends, so " +
+            "what it keeps for each source file adds up over a large repository. A NodeResolutionResult can reach " +
+            "the model of a whole dependency tree, while small markers such as NodeRuntime are fine to keep. A " +
+            "recipe that must keep a heavyweight object opts out with spec.checkLightweightAccumulators = false.");
+        throw new Error(lines.join("\n"));
+    }
+    /** Breadth first, so that the path to what the accumulator keeps is a short one. */
+    walk(recipe, acc, phase) {
+        const visited = new Set();
+        const queue = [];
+        let budget = MAX_OBJECTS;
+        const visit = (value, parent, step) => {
+            if (!walks(value)) {
+                return;
+            }
+            const what = heavyweight(value);
+            if (what) {
+                const path = pathOf({ value, parent, step });
+                let found = this.findings.get(recipe);
+                if (!found) {
+                    this.findings.set(recipe, found = new Map());
+                }
+                const shape = `${path.replace(/\[[^\]]*]/g, "[]")} -> ${what}`;
+                if (!found.has(shape)) {
+                    found.set(shape, { path, what, phase });
+                }
+            }
+            else if (budget > 0 && !visited.has(value)) {
+                budget--;
+                visited.add(value);
+                queue.push({ value, parent, step });
+            }
+        };
+        visit(acc, undefined, "acc");
+        for (let i = 0; i < queue.length; i++) {
+            const node = queue[i];
+            const value = node.value;
+            if (util_1.types.isMap(value)) {
+                Map.prototype.forEach.call(value, (v, k) => {
+                    if (walks(k) || walks(v)) {
+                        visit(k, node, `[${key(k)}]`);
+                        visit(v, node, `[${key(k)}]`);
+                    }
+                });
+            }
+            else if (util_1.types.isSet(value)) {
+                let index = 0;
+                Set.prototype.forEach.call(value, (v) => visit(v, node, `[${index++}]`));
+            }
+            else {
+                // data properties only, since a getter is code of the recipe's own
+                const array = Array.isArray(value);
+                for (const name of Reflect.ownKeys(value)) {
+                    const descriptor = Reflect.getOwnPropertyDescriptor(value, name);
+                    if (descriptor && "value" in descriptor && !(array && name === "length")) {
+                        visit(descriptor.value, node, step(name, array));
+                    }
+                }
+            }
+        }
+    }
+}
+exports.AccumulatorContents = AccumulatorContents;
+/** Whether the walk looks at a value at all, which it doesn't for primitives and for what refers to no tree. */
+function walks(value) {
+    return value !== null && typeof value === "object" && !util_1.types.isProxy(value) && !util_1.types.isPromise(value) &&
+        !util_1.types.isWeakMap(value) && !util_1.types.isWeakSet(value) && !util_1.types.isAnyArrayBuffer(value) &&
+        !util_1.types.isArrayBufferView(value) && !util_1.types.isDate(value) && !util_1.types.isRegExp(value) &&
+        !util_1.types.isBoxedPrimitive(value) &&
+        // a recipe lives for the whole run anyway, and type attribution refers to no tree
+        !(value instanceof recipe_1.Recipe) && !java_1.Type.isType(value);
+}
+/** How to name what the accumulator keeps, when it is a heavyweight object. */
+function heavyweight(value) {
+    const type = (0, heavyweight_1.heavyweightType)(value);
+    if (type === undefined) {
+        return undefined;
+    }
+    else if (typeof type === "function") {
+        return type.name || "an object of an anonymous class";
+    }
+    return (0, tree_1.isSourceFile)(value) ? `${(0, probes_1.typeName)(type)} ${value.sourcePath}` : (0, probes_1.typeName)(type);
+}
+function pathOf(node) {
+    const steps = [];
+    for (let n = node; n; n = n.parent) {
+        steps.push(n.step);
+    }
+    return steps.reverse().join("");
+}
+function step(name, array) {
+    if (typeof name === "symbol") {
+        return `[${name.toString()}]`;
+    }
+    return array && /^\d+$/.test(name) ? `[${name}]` :
+        /^[A-Za-z_$][\w$]*$/.test(name) ? `.${name}` : `[${JSON.stringify(name)}]`;
+}
+/** A map key as the path shows it, without calling code of the recipe's own. */
+function key(k) {
+    var _a, _b;
+    let shown;
+    if (k === null || typeof k !== "object") {
+        shown = typeof k === "symbol" ? k.toString() : String(k);
+    }
+    else if ((0, tree_1.isSourceFile)(k)) {
+        shown = k.sourcePath;
+    }
+    else if (k instanceof recipe_1.Recipe) {
+        shown = k.name;
+    }
+    else if (typeof k.kind === "string") {
+        shown = (0, probes_1.typeName)(k.kind);
+    }
+    else {
+        shown = ((_b = (_a = Object.getPrototypeOf(k)) === null || _a === void 0 ? void 0 : _a.constructor) === null || _b === void 0 ? void 0 : _b.name) || "Object";
+    }
+    return shown.length > 60 ? `${shown.substring(0, 60)}...` : shown;
+}
+//# sourceMappingURL=accumulator-contents.js.map

package/dist/test/accumulator-contents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accumulator-contents.js","sourceRoot":"","sources":["../../src/test/accumulator-contents.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,+BAA2B;AAE3B,sCAAiC;AACjC,kCAAqC;AACrC,gDAA+C;AAC/C,kCAA6B;AAC7B,qCAAkC;AAElC,6EAA6E;AAC7E,MAAM,WAAW,GAAG,MAAO,CAAC;AAE5B,MAAM,SAAS,GAAG,CAAC,CAAC;AAcpB;;;;GAIG;AACH,MAAa,mBAAmB;IAAhC;QACI,oGAAoG;QACnF,aAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;QAE3D,aAAQ,GAAwB,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;YAC7D,MAAM,MAAM,GAAG,IAAI,GAAG,EAAW,CAAC;YAClC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,YAAY,EAAE,CAAC;gBACvC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC9D,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAChB,IAAI,CAAC;wBACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;oBACvC,CAAC;oBAAC,WAAM,CAAC;wBACL,mDAAmD;oBACvD,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC,CAAC;IA6EN,CAAC;IA3EG,eAAe;QACX,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO;QACX,CAAC;QACD,MAAM,KAAK,GAAG,CAAC,0FAA0F;gBACzG,0GAA0G;gBAC1G,iCAAiC,CAAC,CAAC;QACnC,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC1C,KAAK,CAAC,IAAI,CAAC,KAAK,MAAM,QAAQ,CAAC,CAAC;YAChC,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YACtD,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACxE,IAAI,KAAK,CAAC,IAAI,GAAG,SAAS,EAAE,CAAC;gBACzB,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,IAAI,GAAG,SAAS,OAAO,CAAC,CAAC;YACzD,CAAC;QACL,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,6FAA6F;YACpG,uGAAuG;YACvG,oGAAoG;YACpG,qGAAqG,CAAC,CAAC;QAC3G,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,oFAAoF;IAC5E,IAAI,CAAC,MAAc,EAAE,GAAW,EAAE,KAAa;QACnD,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;QAClC,MAAM,KAAK,GAAW,EAAE,CAAC;QACzB,IAAI,MAAM,GAAG,WAAW,CAAC;QACzB,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,MAAwB,EAAE,IAAY,EAAE,EAAE;YACrE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChB,OAAO;YACX,CAAC;YACD,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;YAChC,IAAI,IAAI,EAAE,CAAC;gBACP,MAAM,IAAI,GAAG,MAAM,CAAC,EAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;gBAC3C,IAAI,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACtC,IAAI,CAAC,KAAK,EAAE,CAAC;oBACT,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC;gBACjD,CAAC;gBACD,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;gBAC/D,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpB,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,EAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;gBAC1C,CAAC;YACL,CAAC;iBAAM,IAAI,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3C,MAAM,EAAE,CAAC;gBACT,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnB,KAAK,CAAC,IAAI,CAAC,EAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;YACtC,CAAC;QACL,CAAC,CAAC;QAEF,KAAK,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YACzB,IAAI,YAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAU,EAAE,CAAU,EAAE,EAAE;oBACzD,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;wBACvB,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;wBAC9B,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;oBAClC,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC;iBAAM,IAAI,YAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,IAAI,KAAK,GAAG,CAAC,CAAC;gBACd,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAU,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;YACtF,CAAC;iBAAM,CAAC;gBACJ,mEAAmE;gBACnE,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACnC,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACxC,MAAM,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBACjE,IAAI,UAAU,IAAI,OAAO,IAAI,UAAU,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;wBACvE,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;oBACrD,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;CACJ;AA7FD,kDA6FC;AAED,gHAAgH;AAChH,SAAS,KAAK,CAAC,KAAc;IACzB,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,YAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,YAAK,CAAC,SAAS,CAAC,KAAK,CAAC;QAClG,CAAC,YAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,YAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,YAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC;QACpF,CAAC,YAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,YAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,YAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QACjF,CAAC,YAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAC9B,kFAAkF;QAClF,CAAC,CAAC,KAAK,YAAY,eAAM,CAAC,IAAI,CAAC,WAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,+EAA+E;AAC/E,SAAS,WAAW,CAAC,KAAa;IAC9B,MAAM,IAAI,GAAG,IAAA,6BAAe,EAAC,KAAK,CAAC,CAAC;IACpC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACrB,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC,IAAI,IAAI,iCAAiC,CAAC;IAC1D,CAAC;IACD,OAAO,IAAA,mBAAY,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAA,iBAAQ,EAAC,IAAI,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,IAAA,iBAAQ,EAAC,IAAI,CAAC,CAAC;AAC1F,CAAC;AAED,SAAS,MAAM,CAAC,IAAU;IACtB,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,IAAI,CAAC,GAAqB,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QACnD,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,IAAI,CAAC,IAAqB,EAAE,KAAc;IAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;IAClC,CAAC;IACD,OAAO,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;QAC9C,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;AACnF,CAAC;AAED,gFAAgF;AAChF,SAAS,GAAG,CAAC,CAAU;;IACnB,IAAI,KAAa,CAAC;IAClB,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QACtC,KAAK,GAAG,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7D,CAAC;SAAM,IAAI,IAAA,mBAAY,EAAC,CAAC,CAAC,EAAE,CAAC;QACzB,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC;IACzB,CAAC;SAAM,IAAI,CAAC,YAAY,eAAM,EAAE,CAAC;QAC7B,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC;IACnB,CAAC;SAAM,IAAI,OAAQ,CAAwB,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5D,KAAK,GAAG,IAAA,iBAAQ,EAAE,CAAsB,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;SAAM,CAAC;QACJ,KAAK,GAAG,CAAA,MAAA,MAAA,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,0CAAE,WAAW,0CAAE,IAAI,KAAI,QAAQ,CAAC;IACpE,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;AACtE,CAAC"}

package/dist/test/empty-sources.d.ts

@@ -0,0 +1,14 @@
+import type { SourceSpec } from "./rewrite-test";
+import { Recipe } from "../recipe";
+import { ExecutionContext } from "../execution";
+import { SourceFile } from "../tree";
+import { Result } from "../run";
+/** Runs the recipe on an empty file of each kind it changed, and fails the test if the recipe throws there. */
+export declare class EmptySources {
+    private readonly recipe;
+    private readonly changed;
+    constructor(recipe: Recipe, results: Result[]);
+    assertNoneThrow(parsed: [SourceSpec<any>, SourceFile][], parseCtx: ExecutionContext, recipeCtx: ExecutionContext, cycles: number): Promise<void>;
+    private message;
+}
+//# sourceMappingURL=empty-sources.d.ts.map

package/dist/test/empty-sources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"empty-sources.d.ts","sourceRoot":"","sources":["../../src/test/empty-sources.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACjC,OAAO,EAAC,gBAAgB,EAAC,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAC,UAAU,EAAC,MAAM,SAAS,CAAC;AACnC,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAI9B,+GAA+G;AAC/G,qBAAa,YAAY;IAGT,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkB;gBAEb,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE;IAIxD,eAAe,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,gBAAgB,EACnE,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjF,OAAO,CAAC,OAAO;CAmBlB"}

package/dist/test/empty-sources.js

@@ -0,0 +1,98 @@
+"use strict";
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmptySources = void 0;
+const print_1 = require("../print");
+const probes_1 = require("./probes");
+/** Runs the recipe on an empty file of each kind it changed, and fails the test if the recipe throws there. */
+class EmptySources {
+    constructor(recipe, results) {
+        this.recipe = recipe;
+        this.changed = new Set(results.filter(r => r.before && r.after !== r.before).map(r => r.before));
+    }
+    async assertNoneThrow(parsed, parseCtx, recipeCtx, cycles) {
+        const kinds = new Set();
+        for (const [spec, before] of parsed) {
+            const probe = `empty ${before.kind} ${spec.ext}`;
+            if (!this.changed.has(before) || kinds.has(probe)) {
+                continue;
+            }
+            kinds.add(probe);
+            await (0, probes_1.probeOnce)(this.recipe, probe, async () => {
+                const empty = await parseEmpty(before, spec, parseCtx);
+                const thrown = empty ? await (0, probes_1.thrownBy)(this.recipe, [empty], recipeCtx, cycles) : undefined;
+                if (empty && thrown) {
+                    throw new Error(this.message(empty, thrown.error));
+                }
+            });
+        }
+    }
+    message(empty, thrown) {
+        return [
+            "Check for the structure the recipe edits before using it, so that it handles an empty file or leaves " +
+                "it unchanged instead of throwing.",
+            `${this.recipe.name} threw when run on an empty ${(0, probes_1.typeName)(empty.kind)} at ${empty.sourcePath}` +
+                `${(0, probes_1.withMarkersOf)(empty.markers.markers)}:`,
+            (0, probes_1.describeThrown)(thrown, "    "),
+            "The test gives the recipe only files that contain what it edits, but repositories also hold empty " +
+                "files and files without that block, such as an empty index.ts, a placeholder tsconfig.json or an " +
+                "empty .eslintrc.yml.",
+            "  - return the tree unchanged when what the visitor assumes is absent: check the kind before a cast " +
+                "(`document.value.kind === Json.Kind.Object`), the length before an index (`cu.statements.length > 0`) " +
+                "and undefined before a dereference (`documents.documents[0]?.block`)",
+            "  - if the recipe adds what is missing, build that content correctly for an empty file too",
+            "  - don't catch the exception to make this pass",
+            "Then add a test with an empty source, such as typescript(\"\"), json(\"\") or yaml(\"\"), that states the " +
+                "intended result."
+        ].join("\n");
+    }
+}
+exports.EmptySources = EmptySources;
+/**
+ * An empty file at the source's path, with the markers that describe the source's project, or undefined for a kind of
+ * file that can't be empty.
+ */
+async function parseEmpty(before, spec, parseCtx) {
+    var _a, e_1, _b, _c;
+    // a file its parser resolves a project from, such as a package.json, can't be empty
+    if (before.markers.markers.some(m => m.kind.endsWith("ResolutionResult"))) {
+        return undefined;
+    }
+    let empty;
+    try {
+        const parsed = [];
+        try {
+            for (var _d = true, _e = __asyncValues(spec.parser(parseCtx).parse({ text: "", sourcePath: before.sourcePath })), _f; _f = await _e.next(), _a = _f.done, !_a; _d = true) {
+                _c = _f.value;
+                _d = false;
+                const sourceFile = _c;
+                parsed.push(sourceFile);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = _e.return)) await _b.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        // some kinds of file can't be empty
+        if (parsed.length !== 1 || parsed[0].kind !== before.kind || await print_1.TreePrinters.print(parsed[0]) !== "") {
+            return undefined;
+        }
+        empty = parsed[0];
+    }
+    catch (_g) {
+        return undefined;
+    }
+    const present = new Set(empty.markers.markers.map(m => m.kind));
+    const added = before.markers.markers.filter(m => !present.has(m.kind));
+    return Object.assign(Object.assign({}, empty), { markers: Object.assign(Object.assign({}, empty.markers), { markers: [...empty.markers.markers, ...added] }) });
+}
+//# sourceMappingURL=empty-sources.js.map

package/dist/test/empty-sources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"empty-sources.js","sourceRoot":"","sources":["../../src/test/empty-sources.ts"],"names":[],"mappings":";;;;;;;;;;AAoBA,oCAAsC;AACtC,qCAAsF;AAEtF,+GAA+G;AAC/G,MAAa,YAAY;IAGrB,YAA6B,MAAc,EAAE,OAAiB;QAAjC,WAAM,GAAN,MAAM,CAAQ;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAO,CAAC,CAAC,CAAC;IACtG,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,MAAuC,EAAE,QAA0B,EACnE,SAA2B,EAAE,MAAc;QAC7D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;QAChC,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,SAAS,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACjD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChD,SAAS;YACb,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACjB,MAAM,IAAA,kBAAS,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,EAAE;gBAC3C,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACvD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,IAAA,iBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC3F,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;oBAClB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvD,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAEO,OAAO,CAAC,KAAiB,EAAE,MAAe;QAC9C,OAAO;YACH,uGAAuG;gBACvG,mCAAmC;YACnC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,+BAA+B,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,UAAU,EAAE;gBAC/F,GAAG,IAAA,sBAAa,EAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG;YAC1C,IAAA,uBAAc,EAAC,MAAM,EAAE,MAAM,CAAC;YAC9B,oGAAoG;gBACpG,mGAAmG;gBACnG,sBAAsB;YACtB,sGAAsG;gBACtG,wGAAwG;gBACxG,sEAAsE;YACtE,4FAA4F;YAC5F,iDAAiD;YACjD,4GAA4G;gBAC5G,kBAAkB;SACrB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;CACJ;AA7CD,oCA6CC;AAED;;;GAGG;AACH,KAAK,UAAU,UAAU,CAAC,MAAkB,EAAE,IAAqB,EACzC,QAA0B;;IAChD,oFAAoF;IACpF,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC;QACxE,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,KAAiB,CAAC;IACtB,IAAI,CAAC;QACD,MAAM,MAAM,GAAiB,EAAE,CAAC;;YAChC,KAA+B,eAAA,KAAA,cAAA,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,EAAC,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAC,CAAC,CAAA,IAAA,sDAAE,CAAC;gBAAzE,cAAsE;gBAAtE,WAAsE;gBAA1F,MAAM,UAAU,KAAA,CAAA;gBACvB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC5B,CAAC;;;;;;;;;QACD,oCAAoC;QACpC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,MAAM,oBAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;YACtG,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;IAAC,WAAM,CAAC;QACL,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,uCAAW,KAAK,KAAE,OAAO,kCAAM,KAAK,CAAC,OAAO,KAAE,OAAO,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,OAAG;AAClG,CAAC"}

package/dist/test/formatting-scope.d.ts

@@ -0,0 +1,18 @@
+import { Recipe } from "../recipe";
+import { Cursor, Tree } from "../tree";
+import { Result } from "../run";
+import type { FormattingListener } from "../javascript/format";
+/**
+ * Finds recipes that auto-format a whole source file or class that existed before the run. Test inputs are usually
+ * formatted already, so the reformatting this causes on real code rarely shows in an expected output.
+ */
+export declare class FormattingScope implements FormattingListener {
+    private readonly recipe;
+    private readonly requests;
+    private readonly requested;
+    constructor(recipe: Recipe);
+    onFormat(tree: Tree, stopAfter: Tree | undefined, cursor: Cursor | undefined): void;
+    assertFormattedOnlyWhatChanged(results: Result[]): Promise<void>;
+    private message;
+}
+//# sourceMappingURL=formatting-scope.d.ts.map

package/dist/test/formatting-scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatting-scope.d.ts","sourceRoot":"","sources":["../../src/test/formatting-scope.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACjC,OAAO,EAAC,MAAM,EAA4B,IAAI,EAAC,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAK9B,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAQ7D;;;GAGG;AACH,qBAAa,eAAgB,YAAW,kBAAkB;IAI1C,OAAO,CAAC,QAAQ,CAAC,MAAM;IAHnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiB;IAC1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;gBAEhB,MAAM,EAAE,MAAM;IAG3C,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,GAAG,SAAS,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAY7E,8BAA8B,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BtE,OAAO,CAAC,OAAO;CAqBlB"}

package/dist/test/formatting-scope.js

@@ -0,0 +1,244 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormattingScope = void 0;
+/*
+ * Copyright 2025 the original author or authors.
+ * <p>
+ * Licensed under the Moderne Source Available License (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://docs.moderne.io/licensing/moderne-source-available-license
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const path = __importStar(require("path"));
+const tree_1 = require("../tree");
+const print_1 = require("../print");
+const java_1 = require("../java");
+const javascript_1 = require("../javascript");
+/**
+ * Finds recipes that auto-format a whole source file or class that existed before the run. Test inputs are usually
+ * formatted already, so the reformatting this causes on real code rarely shows in an expected output.
+ */
+class FormattingScope {
+    constructor(recipe) {
+        this.recipe = recipe;
+        this.requests = [];
+        this.requested = new Set();
+    }
+    onFormat(tree, stopAfter, cursor) {
+        var _a;
+        if (stopAfter || !isWhole(tree) || this.requested.has(tree)) {
+            return;
+        }
+        this.requested.add(tree);
+        const sourceFile = (0, tree_1.isSourceFile)(tree) ? tree : cursor === null || cursor === void 0 ? void 0 : cursor.firstEnclosing(tree_1.isSourceFile);
+        const site = sourceFile && callSite((_a = new Error().stack) !== null && _a !== void 0 ? _a : "");
+        if (sourceFile && site) {
+            this.requests.push({ tree, sourceFile: sourceFile.id, callSite: site });
+        }
+    }
+    async assertFormattedOnlyWhatChanged(results) {
+        if (this.requests.length === 0 || await isFormatter(this.recipe)) {
+            return;
+        }
+        const treesByFile = new Map();
+        const found = new Map();
+        for (const request of this.requests) {
+            const result = results.find(r => { var _a; return ((_a = r.before) === null || _a === void 0 ? void 0 : _a.id) === request.sourceFile && r.after && r.after !== r.before; });
+            if (!result || await onlyWhitespaceChanged(result)) {
+                continue;
+            }
+            const before = result.before;
+            let trees = treesByFile.get(before.id);
+            if (!trees) {
+                treesByFile.set(before.id, trees = await treesById(before));
+            }
+            const original = trees.get(request.tree.id);
+            if (original && !await holdsNoneOfItsChildren(original, request.tree)) {
+                let targets = found.get(request.callSite);
+                if (!targets) {
+                    found.set(request.callSite, targets = new Set());
+                }
+                targets.add(`${describe(request.tree)} of ${before.sourcePath}`);
+            }
+        }
+        if (found.size > 0) {
+            throw new Error(this.message(found));
+        }
+    }
+    message(found) {
+        return [
+            "Format only what the recipe changed, not the whole class or file around it. These calls of " +
+                `${this.recipe.name} auto-formatted a whole file or class that existed before the run, with no stopAfter:`,
+            ...[...found].flatMap(([site, targets]) => [`  ${site}`, ...[...targets].map(target => `    ${target}`)]),
+            "That rewrites the whitespace of code the recipe did not change. Test inputs are usually formatted " +
+                "already, so expected outputs rarely show it, but on real code the diff will carry unrelated " +
+                "reformatting. Instead:",
+            "  - format the element you created or replaced: maybeAutoFormat(original, changed, ctx) on that " +
+                "element, or autoFormat(newElement, ctx, undefined, cursor) with a cursor on its parent",
+            "  - when a new element only formats right inside its container, format a copy of the container that " +
+                "holds just the new element, and add the formatted element to the original",
+            "  - after changing a declaration's decorators or modifiers, stop after its header: " +
+                "maybeAutoFormat(c, updated, ctx, updated.name, this.cursor.parent)",
+            "  - when you remove an element, give its prefix to the element that takes its place",
+            "  - re-indent statements you moved with autoIndent(..) rather than autoFormat",
+            "  - a template already formats what it inserts, so drop the extra call",
+            "Recipes named with a `format` segment, such as org.openrewrite.javascript.format.auto-format, are exempt. " +
+                "Any other recipe whose purpose is formatting opts out with spec.checkMinimalFormatting = false."
+        ].join("\n");
+    }
+}
+exports.FormattingScope = FormattingScope;
+/** A source file or a class. */
+function isWhole(tree) {
+    return (0, tree_1.isSourceFile)(tree) || tree.kind === java_1.J.Kind.ClassDeclaration;
+}
+/**
+ * The code that asked for the format, from the stack of the request, or undefined when that is a formatter, a
+ * template, or the scheduler running a recipe whose own visitor is a formatter.
+ */
+function callSite(stack) {
+    const frames = stack.split("\n").map(line => line.trim()).filter(line => line.startsWith("at "))
+        .map(line => {
+        var _a, _b;
+        const m = /^at (?:async )?(?:(.*?) \((.*)\)|(.*))$/.exec(line);
+        return { fn: (_a = m[1]) !== null && _a !== void 0 ? _a : "", location: ((_b = m[2]) !== null && _b !== void 0 ? _b : m[3]).split(process.cwd() + path.sep).join("") };
+    });
+    // the listener, the formatter and the helpers that run it
+    let i = frames.findIndex(f => /\.visit$/.test(f.fn) && inFormat(f));
+    if (i < 0) {
+        return undefined;
+    }
+    let helper;
+    for (i++; i < frames.length && inFormat(frames[i]) && /^(maybeAutoFormat|autoFormat)$/.test(frames[i].fn); i++) {
+        helper = frames[i].fn;
+    }
+    // a precondition and a scanning recipe's editor hand the tree on to the visitor they wrap, after an await
+    while (i < frames.length && (isWrapper(frames[i]) || frames[i].location.startsWith("node:"))) {
+        i++;
+    }
+    const caller = frames[i];
+    if (!caller) {
+        return undefined;
+    }
+    else if (/(^|[\\/])(src|dist)[\\/]visitor\.[jt]s:/.test(caller.location)) {
+        // the visitor that asked is gone from the stack by the time its after-visitors run
+        return "A visitor's afterVisit.push(new AutoformatVisitor()) ran on";
+    }
+    else if (inFormat(caller) || /[\\/]templating[\\/]/.test(caller.location) ||
+        /(^|[\\/])(src|dist)[\\/]run\.[jt]s:/.test(caller.location)) {
+        return undefined;
+    }
+    return `${caller.fn || "<anonymous>"} (${caller.location}) ${helper ? `called ${helper} on` : "ran an AutoformatVisitor on"}`;
+}
+function inFormat(frame) {
+    return /[\\/]format[\\/]/.test(frame.location);
+}
+/** The visit of a precondition or of a scanning recipe's editor, which runs the visitor it wraps. */
+function isWrapper(frame) {
+    return /\.visit$/.test(frame.fn) && /(^|[\\/])(src|dist)[\\/](preconditions|recipe)\.[jt]s:/.test(frame.location);
+}
+/** A formatting recipe may format whole files, and so may the recipes run alongside it. */
+async function isFormatter(recipe) {
+    if (/(^|\.)format\./.test(recipe.name)) {
+        return true;
+    }
+    for (const child of await recipe.recipeList()) {
+        if (await isFormatter(child)) {
+            return true;
+        }
+    }
+    return false;
+}
+async function onlyWhitespaceChanged(result) {
+    const [before, after] = [await print_1.TreePrinters.print(result.before), await print_1.TreePrinters.print(result.after)];
+    return before.replace(/\s+/g, "") === after.replace(/\s+/g, "");
+}
+async function treesById(sourceFile) {
+    const trees = new Map();
+    await new class extends javascript_1.JavaScriptVisitor {
+        async preVisit(tree) {
+            trees.set(tree.id, tree);
+            return tree;
+        }
+    }().visit(sourceFile, undefined);
+    return trees;
+}
+/**
+ * A tree formatted with none of the children it had reformats no existing code below it: a class with its body
+ * emptied to be put back afterwards, or a copy of a container holding only a new element. A tree that had no children
+ * to begin with would format them on real code.
+ */
+async function holdsNoneOfItsChildren(original, formatted) {
+    const children = await childrenOf(original);
+    if (children.size === 0) {
+        return false;
+    }
+    for (const child of await childrenOf(formatted)) {
+        if (children.has(child)) {
+            return false;
+        }
+    }
+    return true;
+}
+/** The members of a class's body, or the trees directly below any other tree. */
+async function childrenOf(tree) {
+    if (tree.kind === java_1.J.Kind.ClassDeclaration) {
+        return new Set(tree.body.statements.map(s => s.element.id));
+    }
+    const children = new Set();
+    await new class extends javascript_1.JavaScriptVisitor {
+        async preVisit(t) {
+            if (t !== tree) {
+                children.add(t.id);
+                this.stopAfterPreVisit();
+            }
+            return t;
+        }
+    }().visit(tree, undefined);
+    return children;
+}
+/** Reads as "all" or "class `A`". */
+function describe(tree) {
+    return (0, tree_1.isSourceFile)(tree) ? "all" : `class \`${tree.name.simpleName}\``;
+}
+//# sourceMappingURL=formatting-scope.js.map

package/dist/test/formatting-scope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatting-scope.js","sourceRoot":"","sources":["../../src/test/formatting-scope.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;GAcG;AACH,2CAA6B;AAE7B,kCAA+D;AAE/D,oCAAsC;AAEtC,kCAA0B;AAC1B,8CAAgD;AAShD;;;GAGG;AACH,MAAa,eAAe;IAIxB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAH1B,aAAQ,GAAc,EAAE,CAAC;QACzB,cAAS,GAAG,IAAI,GAAG,EAAQ,CAAC;IAG7C,CAAC;IAED,QAAQ,CAAC,IAAU,EAAE,SAA2B,EAAE,MAA0B;;QACxE,IAAI,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1D,OAAO;QACX,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzB,MAAM,UAAU,GAAG,IAAA,mBAAY,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,CAAC,mBAAY,CAAC,CAAC;QACpF,MAAM,IAAI,GAAG,UAAU,IAAI,QAAQ,CAAC,MAAA,IAAI,KAAK,EAAE,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;QAC7D,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC;QAC1E,CAAC;IACL,CAAC;IAED,KAAK,CAAC,8BAA8B,CAAC,OAAiB;QAClD,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/D,OAAO;QACX,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;QACrD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAuB,CAAC;QAC7C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAC,OAAA,CAAA,MAAA,CAAC,CAAC,MAAM,0CAAE,EAAE,MAAK,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,CAAA,EAAA,CAAC,CAAC;YACzG,IAAI,CAAC,MAAM,IAAI,MAAM,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACjD,SAAS;YACb,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAO,CAAC;YAC9B,IAAI,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACvC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YAChE,CAAC;YACD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC5C,IAAI,QAAQ,IAAI,CAAC,MAAM,sBAAsB,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpE,IAAI,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC1C,IAAI,CAAC,OAAO,EAAE,CAAC;oBACX,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC;gBACrD,CAAC;gBACD,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;YACrE,CAAC;QACL,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC;IACL,CAAC;IAEO,OAAO,CAAC,KAA+B;QAC3C,OAAO;YACH,6FAA6F;gBAC7F,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,uFAAuF;YAC1G,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,EAAE,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC,CAAC;YACzG,oGAAoG;gBACpG,8FAA8F;gBAC9F,wBAAwB;YACxB,kGAAkG;gBAClG,wFAAwF;YACxF,sGAAsG;gBACtG,2EAA2E;YAC3E,qFAAqF;gBACrF,oEAAoE;YACpE,qFAAqF;YACrF,+EAA+E;YAC/E,wEAAwE;YACxE,4GAA4G;gBAC5G,iGAAiG;SACpG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;CACJ;AAtED,0CAsEC;AAED,gCAAgC;AAChC,SAAS,OAAO,CAAC,IAAU;IACvB,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;AACvE,CAAC;AAOD;;;GAGG;AACH,SAAS,QAAQ,CAAC,KAAa;IAC3B,MAAM,MAAM,GAAY,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SACpG,GAAG,CAAC,IAAI,CAAC,EAAE;;QACR,MAAM,CAAC,GAAG,yCAAyC,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC;QAChE,OAAO,EAAC,EAAE,EAAE,MAAA,CAAC,CAAC,CAAC,CAAC,mCAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAA,CAAC,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;IACP,0DAA0D;IAC1D,IAAI,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACR,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,MAA0B,CAAC;IAC/B,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,gCAAgC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7G,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,CAAC;IACD,0GAA0G;IAC1G,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC3F,CAAC,EAAE,CAAC;IACR,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO,SAAS,CAAC;IACrB,CAAC;SAAM,IAAI,yCAAyC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzE,mFAAmF;QACnF,OAAO,6DAA6D,CAAC;IACzE,CAAC;SAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvE,qCAAqC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9D,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,MAAM,CAAC,EAAE,IAAI,aAAa,KAAK,MAAM,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,MAAM,KAAK,CAAC,CAAC,CAAC,6BAA6B,EAAE,CAAC;AAClI,CAAC;AAED,SAAS,QAAQ,CAAC,KAAY;IAC1B,OAAO,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AACnD,CAAC;AAED,qGAAqG;AACrG,SAAS,SAAS,CAAC,KAAY;IAC3B,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,wDAAwD,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AACtH,CAAC;AAED,2FAA2F;AAC3F,KAAK,UAAU,WAAW,CAAC,MAAc;IACrC,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,MAAM,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QAC5C,IAAI,MAAM,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAC,MAAc;IAC/C,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,oBAAY,CAAC,KAAK,CAAC,MAAM,CAAC,MAAO,CAAC,EAAE,MAAM,oBAAY,CAAC,KAAK,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC,CAAC;IAC5G,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACpE,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,UAAsB;IAC3C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAc,CAAC;IACpC,MAAM,IAAI,KAAM,SAAQ,8BAA4B;QAC7B,KAAK,CAAC,QAAQ,CAAC,IAAO;YACrC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACjC,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,sBAAsB,CAAC,QAAc,EAAE,SAAe;IACjE,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC5C,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,MAAM,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9C,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,iFAAiF;AACjF,KAAK,UAAU,UAAU,CAAC,IAAU;IAChC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAC,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxC,OAAO,IAAI,GAAG,CAAE,IAA2B,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACxF,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAQ,CAAC;IACjC,MAAM,IAAI,KAAM,SAAQ,8BAA4B;QAC7B,KAAK,CAAC,QAAQ,CAAC,CAAI;YAClC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;gBACb,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACnB,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,CAAC;YACD,OAAO,CAAC,CAAC;QACb,CAAC;KACJ,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3B,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED,qCAAqC;AACrC,SAAS,QAAQ,CAAC,IAAU;IACxB,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAY,IAA2B,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC;AACpG,CAAC"}

package/dist/test/probes.d.ts

@@ -0,0 +1,25 @@
+import { Recipe } from "../recipe";
+import { ExecutionContext } from "../execution";
+import { SourceFile } from "../tree";
+import { Marker } from "../markers";
+/**
+ * Runs `run`, a probe of the recipe on what `probe` names, unless this process ran that probe before or the recipe's
+ * probes have taken the time cap, and charges the recipe the time it takes.
+ */
+export declare function probeOnce(recipe: Recipe, probe: string, run: () => Promise<void>): Promise<void>;
+/** Adds `ms` to the time the recipe's probes have taken in this process. */
+export declare function charge(recipe: Recipe, ms: number): Promise<void>;
+/** The error the recipe threw when run on `sources` for up to `cycles` cycles, if it threw. */
+export declare function thrownBy(recipe: Recipe, sources: SourceFile[], recipeCtx: ExecutionContext, cycles: number): Promise<{
+    error: unknown;
+} | undefined>;
+/**
+ * The error the recipe threw, with the first line of its message and the first frame of its stack, and when that
+ * frame is in a dependency, the first frame that isn't.
+ */
+export declare function describeThrown(thrown: unknown, indent: string): string;
+/** Reads as " with the markers of the test's source (Autodetect, PrettierStyle)", or as nothing. */
+export declare function withMarkersOf(markers: Marker[]): string;
+/** Reads as "PlainText" or "JS.CompilationUnit". */
+export declare function typeName(kind: string): string;
+//# sourceMappingURL=probes.d.ts.map

package/dist/test/probes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"probes.d.ts","sourceRoot":"","sources":["../../src/test/probes.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACjC,OAAO,EAAC,gBAAgB,EAAC,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAC,UAAU,EAAC,MAAM,SAAS,CAAC;AAInC,OAAO,EAAC,MAAM,EAAC,MAAM,YAAY,CAAC;AAiBlC;;;GAGG;AACH,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAmBtG;AAED,4EAA4E;AAC5E,wBAAsB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGtE;AA4BD,+FAA+F;AAC/F,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAClE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAAE,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,CAAC,CAqBtF;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAmBtE;AAED,oGAAoG;AACpG,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAGvD;AAED,oDAAoD;AACpD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7C"}