@takodotid/circuit 0.34.3 → 0.36.0

package/src/cli/new.ts

@@ -3,199 +3,232 @@
 import { spawnSync } from "node:child_process";
 import { cpSync, existsSync, readdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
 import { basename, dirname, join, relative, resolve } from "node:path";
-import { createInterface } from "node:readline/promises";
 import { fileURLToPath } from "node:url";
+import * as prompts from "@clack/prompts";
+
+type Manager = keyof typeof Scaffold.MANAGERS;
+
+type Pattern = keyof typeof Scaffold.PATTERNS;
+
+/** The answers given as options. A question is asked only for an answer missing here. */
+export type ScaffoldOptions = {
+    pattern?: string;
+    asn?: string;
+    onePassword?: boolean;
+    use?: string;
+    install: boolean;
+};
+
+export class Scaffold {
+    private static readonly ROOT = Scaffold.packageRoot();
+    private static readonly TEMPLATES = join(Scaffold.ROOT, "templates");
+    private static readonly CIRCUIT = JSON.parse(readFileSync(join(Scaffold.ROOT, "package.json"), "utf8"));
+
+    /** How each package manager installs and runs. The templates are written for npm; the others are swapped in. */
+    static readonly MANAGERS = {
+        npm: { install: "npm install", run: "npx circuit", types: "node" },
+        pnpm: { install: "pnpm install", run: "pnpm circuit", types: "node" },
+        bun: { install: "bun install", run: "bun circuit", types: "bun" },
+    } as const;
+
+    static readonly PATTERNS = {
+        "single-site": {
+            title: "A single site",
+            fits: "a home, an office or an internal network: a router and a switch, no BGP",
+            asn: false,
+        },
+        "edge-router": { title: "An edge router", fits: "your own AS number, with an IP transit and an internet exchange", asn: true },
+        colocation: {
+            title: "Colocation with tenants",
+            fits: "a provider whose customers each get their own VLANs, addresses and ports",
+            asn: true,
+        },
+    } as const;
+
+    /** The AS number the templates use, reserved for documentation by RFC 5398. */
+    private static readonly EXAMPLE_ASN = "64500";
+
+    /** Circuit's own directory: this file runs from src/cli/ in Bun, and from dist/ once built. */
+    private static packageRoot(): string {
+        let directory = dirname(fileURLToPath(import.meta.url));
+
+        while (!existsSync(join(directory, "templates"))) {
+            const parent = dirname(directory);
+            if (parent === directory) throw new Error("Circuit's templates are missing from its package");
+            directory = parent;
+        }
 
-/** Circuit's own directory: this file runs from src/cli/ in Bun, and from dist/ once built. */
-function packageRoot(): string {
-    let directory = dirname(fileURLToPath(import.meta.url));
-
-    while (!existsSync(join(directory, "templates"))) {
-        const parent = dirname(directory);
-        if (parent === directory) throw new Error("Circuit's templates are missing from its package");
-        directory = parent;
+        return directory;
     }
 
-    return directory;
-}
-
-const ROOT = packageRoot();
-const TEMPLATES = join(ROOT, "templates");
-const circuit = JSON.parse(readFileSync(join(ROOT, "package.json"), "utf8"));
-
-/** How each package manager installs and runs. The templates are written for npm; the others are swapped in. */
-const MANAGERS = {
-    npm: { install: "npm install", run: "npx circuit", types: "node" },
-    pnpm: { install: "pnpm install", run: "pnpm circuit", types: "node" },
-    bun: { install: "bun install", run: "bun circuit", types: "bun" },
-} as const;
-
-type Manager = keyof typeof MANAGERS;
-
-/** The package manager that started this, from what it says about itself, such as `pnpm/9.1.0 npm/? node/v22`. */
-function detectManager(): Manager {
-    const agent = process.env.npm_config_user_agent ?? "";
-    if (agent.startsWith("pnpm/")) return "pnpm";
-    if (agent.startsWith("bun/") || process.versions.bun) return "bun";
-    return "npm";
-}
-
-const PATTERNS = {
-    "single-site": { title: "A single site", fits: "a home, an office or an internal network: a router and a switch, no BGP", asn: false },
-    "edge-router": { title: "An edge router", fits: "your own AS number, with an IP transit and an internet exchange", asn: true },
-    colocation: {
-        title: "Colocation with tenants",
-        fits: "a provider whose customers each get their own VLANs, addresses and ports",
-        asn: true,
-    },
-} as const;
-
-type Pattern = keyof typeof PATTERNS;
-
-/** The AS number the templates use, reserved for documentation by RFC 5398. */
-const EXAMPLE_ASN = "64500";
+    /** The package manager that started this, from what it says about itself, such as `pnpm/9.1.0 npm/? node/v22`. */
+    private static detectManager(): Manager {
+        const agent = process.env.npm_config_user_agent ?? "";
+        if (agent.startsWith("pnpm/")) return "pnpm";
+        if (agent.startsWith("bun/") || process.versions.bun) return "bun";
+        return "npm";
+    }
 
-const USAGE = `usage: circuit new [directory] [options]
+    private static fail(message: string): never {
+        console.error(message);
+        process.exit(1);
+    }
 
-  --pattern <name>   single-site, edge-router or colocation
-  --asn <number>     your AS number, for edge-router and colocation
-  --1password        write .env with 1Password references instead of empty values
-  --use <manager>    npm, pnpm or bun; the one that ran this by default
-  --no-install       do not install the dependencies`;
+    /** Every file under a directory, relative to it. */
+    private static filesIn(directory: string): string[] {
+        return readdirSync(directory, { recursive: true, withFileTypes: true })
+            .filter((entry) => entry.isFile())
+            .map((entry) => relative(directory, join(entry.parentPath, entry.name)));
+    }
 
-function fail(message: string): never {
-    console.error(message);
-    process.exit(1);
-}
+    /** Why a project cannot be created in this directory, or undefined when it can. */
+    private static notEmpty(directory: string): string | undefined {
+        const target = resolve(process.cwd(), directory);
+        return existsSync(target) && readdirSync(target).length ? `${target} is not empty` : undefined;
+    }
 
-/** The value of `--name value` or `--name=value`. */
-function option(args: string[], name: string): string | undefined {
-    const at = args.indexOf(`--${name}`);
-    if (at >= 0) return args[at + 1];
-    return args.find((arg) => arg.startsWith(`--${name}=`))?.slice(name.length + 3);
-}
+    /** The answer to a question in a terminal, or the fallback when nobody is there to answer. Cancelling a question ends the run. */
+    private static async ask<T>(question: () => Promise<NoInfer<T> | symbol>, fallback: T): Promise<T> {
+        if (process.stdin.isTTY !== true) return fallback;
 
-/** Every file under a directory, relative to it. */
-function filesIn(directory: string): string[] {
-    return readdirSync(directory, { recursive: true, withFileTypes: true })
-        .filter((entry) => entry.isFile())
-        .map((entry) => relative(directory, join(entry.parentPath, entry.name)));
-}
+        const answer = await question();
+        if (prompts.isCancel(answer)) {
+            prompts.cancel("Nothing created.");
+            process.exit(1);
+        }
 
-export async function create(args: string[]): Promise<void> {
-    if (args.includes("--help") || args.includes("-h")) {
-        console.log(USAGE);
-        return;
+        return answer as T;
     }
 
-    const valued = new Set(["--pattern", "--asn", "--use"]);
-    const positional = args.filter((arg, index) => !arg.startsWith("--") && !valued.has(args[index - 1] ?? ""));
-
-    const interactive = process.stdin.isTTY === true;
-    const terminal = interactive ? createInterface({ input: process.stdin, output: process.stdout }) : undefined;
-
-    // The answer typed, or the fallback when nothing is typed or nobody is there to type.
-    const ask = async (question: string, fallback: string) => {
-        if (!terminal) return fallback;
-        const answer = (await terminal.question(`${question} (${fallback}): `)).trim();
-        return answer || fallback;
-    };
-
-    const directory = positional[0] ?? (await ask("Directory for the project", "my-network"));
-    const target = resolve(process.cwd(), directory);
-    if (existsSync(target) && readdirSync(target).length) fail(`${target} is not empty`);
-
-    let pattern = option(args, "pattern") as Pattern | undefined;
-    if (!pattern) {
-        const names = Object.keys(PATTERNS) as Pattern[];
-        if (terminal) {
-            console.log("\nWhich is closest to your network?");
-            names.forEach((name, index) => console.log(`  ${index + 1}. ${PATTERNS[name].title}: ${PATTERNS[name].fits}`));
+    static async create(directoryArgument: string | undefined, options: ScaffoldOptions): Promise<void> {
+        const directory =
+            directoryArgument ??
+            (await Scaffold.ask(
+                () =>
+                    prompts.text({
+                        message: "Directory for the project",
+                        placeholder: "my-network",
+                        defaultValue: "my-network",
+                        validate: (value) => Scaffold.notEmpty(value || "my-network"),
+                    }),
+                "my-network"
+            ));
+
+        const notEmpty = Scaffold.notEmpty(directory);
+        if (notEmpty) Scaffold.fail(notEmpty);
+        const target = resolve(process.cwd(), directory);
+
+        const names = Object.keys(Scaffold.PATTERNS) as Pattern[];
+        const pattern =
+            options.pattern ??
+            (await Scaffold.ask(
+                () =>
+                    prompts.select({
+                        message: "Which is closest to your network?",
+                        options: names.map((name) => ({
+                            value: name,
+                            label: Scaffold.PATTERNS[name].title,
+                            hint: Scaffold.PATTERNS[name].fits,
+                        })),
+                    }),
+                names[0]!
+            ));
+        if (!Object.hasOwn(Scaffold.PATTERNS, pattern)) Scaffold.fail(`no pattern ${pattern}; there are ${names.join(", ")}`);
+        const chosen = Scaffold.PATTERNS[pattern as Pattern];
+
+        let asn = options.asn;
+        if (!asn && chosen.asn) {
+            asn = await Scaffold.ask(
+                () =>
+                    prompts.text({
+                        message: "Your AS number, or press enter to keep the documentation example",
+                        placeholder: Scaffold.EXAMPLE_ASN,
+                        defaultValue: Scaffold.EXAMPLE_ASN,
+                        validate: (value) => (!value || /^\d+$/.test(value) ? undefined : `${value} is not an AS number`),
+                    }),
+                Scaffold.EXAMPLE_ASN
+            );
         }
-        pattern = names[Number(await ask("Number", "1")) - 1];
-    }
-    if (!pattern || !(pattern in PATTERNS)) fail(`no pattern ${pattern}; there are ${Object.keys(PATTERNS).join(", ")}`);
+        if (asn && !/^\d+$/.test(asn)) Scaffold.fail(`${asn} is not an AS number`);
 
-    let asn = option(args, "asn");
-    if (!asn && PATTERNS[pattern].asn) {
-        asn = await ask("Your AS number, or press enter to keep the documentation example", EXAMPLE_ASN);
-    }
-    if (asn && !/^\d+$/.test(asn)) fail(`${asn} is not an AS number`);
-
-    const manager = (option(args, "use") ?? detectManager()) as Manager;
-    if (!(manager in MANAGERS)) fail(`no package manager ${manager}; there are ${Object.keys(MANAGERS).join(", ")}`);
-    const { install, run, types } = MANAGERS[manager];
-
-    const onePassword =
-        args.includes("--1password") || (await ask("Keep the secrets in 1Password? y or n", "n")).toLowerCase().startsWith("y");
-    terminal?.close();
-
-    // The pattern's files, then what every project has. npm leaves out a file named .gitignore, so it travels without the dot.
-    cpSync(join(TEMPLATES, pattern), target, { recursive: true });
-    cpSync(join(TEMPLATES, "project"), target, { recursive: true });
-    renameSync(join(target, "gitignore"), join(target, ".gitignore"));
-
-    // What the templates say about npm, said for the package manager in use.
-    for (const file of ["AGENTS.md", "README.md", "tsconfig.json"]) {
-        const path = join(target, file);
-        const text = readFileSync(path, "utf8")
-            .replaceAll("npx circuit", run)
-            .replaceAll("npm install", install)
-            .replaceAll('"types": ["node"]', `"types": ["${types}"]`);
-        writeFileSync(path, text);
-    }
+        const manager = options.use ?? Scaffold.detectManager();
+        if (!Object.hasOwn(Scaffold.MANAGERS, manager)) {
+            Scaffold.fail(`no package manager ${manager}; there are ${Object.keys(Scaffold.MANAGERS).join(", ")}`);
+        }
+        const { install, run, types } = Scaffold.MANAGERS[manager as Manager];
+
+        const onePassword =
+            options.onePassword ||
+            (await Scaffold.ask(() => prompts.confirm({ message: "Keep the secrets in 1Password?", initialValue: false }), false));
+
+        // The pattern's files, then what every project has. npm leaves out a file named .gitignore, so it travels without the dot.
+        cpSync(join(Scaffold.TEMPLATES, pattern), target, { recursive: true });
+        cpSync(join(Scaffold.TEMPLATES, "project"), target, { recursive: true });
+        renameSync(join(target, "gitignore"), join(target, ".gitignore"));
+
+        // What the templates say about npm, said for the package manager in use.
+        for (const file of ["AGENTS.md", "README.md", "tsconfig.json"]) {
+            const path = join(target, file);
+            const text = readFileSync(path, "utf8")
+                .replaceAll("npx circuit", run)
+                .replaceAll("npm install", install)
+                .replaceAll('"types": ["node"]', `"types": ["${types}"]`);
+            writeFileSync(path, text);
+        }
 
-    const sources = filesIn(target).filter((file) => file.endsWith(".ts"));
-    const secrets = new Set<string>();
+        const sources = Scaffold.filesIn(target).filter((file) => file.endsWith(".ts"));
+        const secrets = new Set<string>();
 
-    for (const file of sources) {
-        const path = join(target, file);
-        let text = readFileSync(path, "utf8");
+        for (const file of sources) {
+            const path = join(target, file);
+            let text = readFileSync(path, "utf8");
 
-        if (asn && asn !== EXAMPLE_ASN) text = text.replaceAll(new RegExp(`\\b${EXAMPLE_ASN}\\b`, "g"), asn);
-        for (const [, name] of text.matchAll(/secret\("([A-Z0-9_]+)"\)/g)) secrets.add(name!);
+            if (asn && asn !== Scaffold.EXAMPLE_ASN) text = text.replaceAll(new RegExp(`\\b${Scaffold.EXAMPLE_ASN}\\b`, "g"), asn);
+            for (const [, name] of text.matchAll(/secret\("([A-Z0-9_]+)"\)/g)) secrets.add(name!);
 
-        writeFileSync(path, text);
-    }
+            writeFileSync(path, text);
+        }
 
-    const env = [
-        "# Secrets for Circuit. Never commit this file.",
-        "# A value is the secret itself, or a 1Password reference, op://vault/item/field, read with the 1Password CLI.",
-        ...[...secrets].sort().map((name) => (onePassword ? `${name}=op://Network/${name}/password` : `${name}=`)),
-        "",
-    ];
-    writeFileSync(join(target, ".env"), env.join("\n"));
-
-    const name = basename(target)
-        .toLowerCase()
-        .replace(/[^a-z0-9-]+/g, "-");
-    const packageJson = {
-        name,
-        private: true,
-        type: "module",
-        dependencies: { "@takodotid/circuit": circuit.version },
-        devDependencies: { [`@types/${types}`]: circuit.devDependencies[`@types/${types}`] },
-    };
-    writeFileSync(join(target, "package.json"), JSON.stringify(packageJson, null, 4) + "\n");
-
-    if (!args.includes("--no-install")) {
-        // npm and pnpm are scripts on Windows, which only a shell runs.
-        const result = spawnSync(install, { cwd: target, stdio: "inherit", shell: true });
-        if (result.status !== 0) console.log(`${install} failed; run it again in the project.`);
-    }
+        const env = [
+            "# Secrets for Circuit. Never commit this file.",
+            "# A value is the secret itself, or a 1Password reference, op://vault/item/field, read with the 1Password CLI.",
+            "# Put quotes around a value that has a # in it: without them, # starts a comment.",
+            ...[...secrets].sort().map((name) => (onePassword ? `${name}=op://Network/${name}/password` : `${name}=`)),
+            "",
+        ];
+        writeFileSync(join(target, ".env"), env.join("\n"));
+
+        const name = basename(target)
+            .toLowerCase()
+            .replace(/[^a-z0-9-]+/g, "-");
+        const packageJson = {
+            name,
+            private: true,
+            type: "module",
+            dependencies: { "@takodotid/circuit": Scaffold.CIRCUIT.version },
+            devDependencies: { [`@types/${types}`]: Scaffold.CIRCUIT.devDependencies[`@types/${types}`] },
+        };
+        writeFileSync(join(target, "package.json"), JSON.stringify(packageJson, null, 4) + "\n");
+
+        if (options.install) {
+            // npm and pnpm are scripts on Windows, which only a shell runs.
+            const result = spawnSync(install, { cwd: target, stdio: "inherit", shell: true });
+            if (result.status !== 0) console.log(`${install} failed; run it again in the project.`);
+        }
 
-    const steps = [
-        `cd ${directory}`,
-        onePassword
-            ? `Point each line of .env at the item that holds it in 1Password, then run: ${run} secrets`
-            : `Fill in each password in .env, then run: ${run} secrets`,
-        "Change the names, addresses and ports in the device files to your own.",
-        ...(PATTERNS[pattern].asn && (!asn || asn === EXAMPLE_ASN) ? ["Put your own AS number in routing.ts."] : []),
-        `${run} validate`,
-        `${run} snapshot, then ${run} diff, to see what would change on each device`,
-    ];
-
-    console.log(`\nCreated ${directory} from the pattern "${PATTERNS[pattern].title}".\n\nNext:`);
-    steps.forEach((step, index) => console.log(`  ${index + 1}. ${step}`));
-    console.log(`\nWhat each file does: https://circuit.tako.id/patterns/${pattern}`);
+        const steps = [
+            `cd ${directory}`,
+            onePassword
+                ? `Point each line of .env at the item that holds it in 1Password, then run: ${run} secrets`
+                : `Fill in each password in .env, then run: ${run} secrets`,
+            "Change the names, addresses and ports in the device files to your own.",
+            ...(chosen.asn && (!asn || asn === Scaffold.EXAMPLE_ASN) ? ["Put your own AS number in routing.ts."] : []),
+            `${run} validate`,
+            `${run} snapshot, then ${run} diff, to see what would change on each device`,
+        ];
+
+        console.log(`\nCreated ${directory} from the pattern "${chosen.title}".\n\nNext:`);
+        steps.forEach((step, index) => console.log(`  ${index + 1}. ${step}`));
+        console.log(`\nWhat each file does: https://circuit.tako.id/patterns/${pattern}`);
+    }
 }

package/src/cli/rename.ts

@@ -2,7 +2,7 @@
 
 import { existsSync, readFileSync, renameSync, writeFileSync } from "node:fs";
 import { basename, dirname, extname, join, resolve } from "node:path";
-import { declaresDevice, projectSources } from "../core/files";
+import { ProjectFiles } from "../core/project-files";
 
 /** One line that changes. */
 export type LineChange = { file: string; line: number; before: string; after: string };
@@ -15,115 +15,121 @@ export type RenamePlan = {
     mentions: { file: string; line: number; text: string }[];
 };
 
-const escape = (text: string) => text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+export class Rename {
+    private static escape(text: string): string {
+        return text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+    }
 
-/**
- * Plan renaming a device from `from` to `to` in the project at `root`.
- *
- * A string that is exactly the old name becomes the new name: `name: "edge-01"`, `link: { device: "edge-01", ... }`, a check's list of routers, and a key such as a tenant's ports by device, which would otherwise no longer be found. A BGP neighbor named after the device is renamed too, which renames its session on the device: `circuit diff` shows it.
- */
-export function planRename(root: string, from: string, to: string, options: { file: boolean; snapshots: string[] }): RenamePlan {
-    const changes: LineChange[] = [];
-    const moves: RenamePlan["moves"] = [];
+    /**
+     * Plan renaming a device from `from` to `to` in the project at `root`.
+     *
+     * A string that is exactly the old name becomes the new name: `name: "edge-01"`, `link: { device: "edge-01", ... }`, a check's list of routers, and a key such as a tenant's ports by device, which would otherwise no longer be found. A BGP neighbor named after the device is renamed too, which renames its session on the device: `circuit diff` shows it.
+     */
+    static plan(root: string, from: string, to: string, options: { file: boolean; snapshots: string[] }): RenamePlan {
+        const changes: LineChange[] = [];
+        const moves: RenamePlan["moves"] = [];
 
-    const exact = new RegExp(`(["'\`])${escape(from)}\\1`, "g");
-    const anywhere = new RegExp(`(^|[^A-Za-z0-9_.-])${escape(from)}(?![A-Za-z0-9_-])`);
+        const exact = new RegExp(`(["'\`])${Rename.escape(from)}\\1`, "g");
+        const anywhere = new RegExp(`(^|[^A-Za-z0-9_.-])${Rename.escape(from)}(?![A-Za-z0-9_-])`);
 
-    const sources = projectSources(root);
-    const declaring = new Set<string>();
+        const sources = ProjectFiles.sources(root);
+        const declaring = new Set<string>();
 
-    for (const file of sources) {
-        const text = readFileSync(join(root, file), "utf8");
-        const lines = text.split("\n");
+        for (const file of sources) {
+            const text = readFileSync(join(root, file), "utf8");
+            const lines = text.split("\n");
 
-        // The device's own file calls defineDevice and gives it the name.
-        if (declaresDevice(text, from)) declaring.add(file);
+            // The device's own file calls defineDevice and gives it the name.
+            if (ProjectFiles.declaresDevice(text, from)) declaring.add(file);
 
-        for (const [index, before] of lines.entries()) {
-            const after = before.replace(exact, (_match, quote: string) => `${quote}${to}${quote}`);
-            if (after !== before) changes.push({ file, line: index + 1, before, after });
+            for (const [index, before] of lines.entries()) {
+                const after = before.replace(exact, (_match, quote: string) => `${quote}${to}${quote}`);
+                if (after !== before) changes.push({ file, line: index + 1, before, after });
+            }
         }
-    }
-
-    if (!declaring.size) {
-        throw new Error(
-            `no file declares name: "${from}"; the name may be built from parts, such as a template string, so rename it by hand`
-        );
-    }
 
-    for (const snapshot of options.snapshots) {
-        moves.push({ from: snapshot, to: join(dirname(snapshot), `${to}${extname(snapshot)}`) });
-    }
+        if (!declaring.size) {
+            throw new Error(
+                `no file declares name: "${from}"; the name may be built from parts, such as a template string, so rename it by hand`
+            );
+        }
 
-    if (options.file) {
-        if (declaring.size > 1) throw new Error(`${[...declaring].join(" and ")} both declare name: "${from}"; rename the file by hand`);
+        for (const snapshot of options.snapshots) {
+            // A state file is named after the device, then its kind: `tor-01.cfg`, `tor-01.lldp.json`.
+            moves.push({ from: snapshot, to: join(dirname(snapshot), `${to}${basename(snapshot).slice(from.length)}`) });
+        }
 
-        const [file] = [...declaring] as [string];
-        const target = join(dirname(file), `${to}${extname(file)}`);
-        if (existsSync(join(root, target))) throw new Error(`${target} already exists`);
+        if (options.file) {
+            if (declaring.size > 1)
+                throw new Error(`${[...declaring].join(" and ")} both declare name: "${from}"; rename the file by hand`);
 
-        moves.push({ from: file, to: target });
-        changes.push(...importChanges(root, sources, file, target, changes));
-    }
+            const [file] = [...declaring] as [string];
+            const target = join(dirname(file), `${to}${extname(file)}`);
+            if (existsSync(join(root, target))) throw new Error(`${target} already exists`);
 
-    // What still names the device once every change is made.
-    const mentions = sources.flatMap((file) =>
-        readFileSync(join(root, file), "utf8")
-            .split("\n")
-            .flatMap((original, index) => {
-                const text = changes.find((change) => change.file === file && change.line === index + 1)?.after ?? original;
-                return anywhere.test(text) ? [{ file, line: index + 1, text: text.trim() }] : [];
-            })
-    );
-
-    return { changes, moves, mentions };
-}
+            moves.push({ from: file, to: target });
+            changes.push(...Rename.importChanges(root, sources, file, target, changes));
+        }
 
-/** Imports of a file that moves, pointed at its new name. Lines already changed are changed further. */
-function importChanges(root: string, sources: string[], file: string, target: string, earlier: LineChange[]): LineChange[] {
-    const result: LineChange[] = [];
-    const withoutExtension = (path: string) => path.replace(/\.(ts|mts|cts|js|mjs|cjs)$/, "");
-    const moved = withoutExtension(resolve(root, file));
-
-    for (const source of sources) {
-        const lines = readFileSync(join(root, source), "utf8").split("\n");
-
-        for (const [index, original] of lines.entries()) {
-            const line = index + 1;
-            const changed = earlier.find((change) => change.file === source && change.line === line);
-            const before = changed?.after ?? original;
-
-            // A relative specifier that resolves to the moved file keeps its own form, extension or not.
-            const after = before.replace(
-                /(\bfrom\s+|\bimport\s*\(\s*)(["'])(\.{1,2}\/[^"']+)\2/g,
-                (match, lead: string, quote: string, specifier: string) => {
-                    if (withoutExtension(resolve(root, dirname(source), specifier)) !== moved) return match;
-
-                    const extension = specifier.match(/\.(ts|mts|cts|js|mjs|cjs)$/)?.[0] ?? "";
-                    const renamed = `${dirname(specifier)}/${basename(withoutExtension(target))}${extension}`;
-                    return `${lead}${quote}${renamed}${quote}`;
-                }
-            );
+        // What still names the device once every change is made.
+        const mentions = sources.flatMap((file) =>
+            readFileSync(join(root, file), "utf8")
+                .split("\n")
+                .flatMap((original, index) => {
+                    const text = changes.find((change) => change.file === file && change.line === index + 1)?.after ?? original;
+                    return anywhere.test(text) ? [{ file, line: index + 1, text: text.trim() }] : [];
+                })
+        );
 
-            if (after === before) continue;
+        return { changes, moves, mentions };
+    }
 
-            if (changed) changed.after = after;
-            else result.push({ file: source, line, before: original, after });
+    /** Imports of a file that moves, pointed at its new name. Lines already changed are changed further. */
+    private static importChanges(root: string, sources: string[], file: string, target: string, earlier: LineChange[]): LineChange[] {
+        const result: LineChange[] = [];
+        const withoutExtension = (path: string) => path.replace(/\.(ts|mts|cts|js|mjs|cjs)$/, "");
+        const moved = withoutExtension(resolve(root, file));
+
+        for (const source of sources) {
+            const lines = readFileSync(join(root, source), "utf8").split("\n");
+
+            for (const [index, original] of lines.entries()) {
+                const line = index + 1;
+                const changed = earlier.find((change) => change.file === source && change.line === line);
+                const before = changed?.after ?? original;
+
+                // A relative specifier that resolves to the moved file keeps its own form, extension or not.
+                const after = before.replace(
+                    /(\bfrom\s+|\bimport\s*\(\s*)(["'])(\.{1,2}\/[^"']+)\2/g,
+                    (match, lead: string, quote: string, specifier: string) => {
+                        if (withoutExtension(resolve(root, dirname(source), specifier)) !== moved) return match;
+
+                        const extension = specifier.match(/\.(ts|mts|cts|js|mjs|cjs)$/)?.[0] ?? "";
+                        const renamed = `${dirname(specifier)}/${basename(withoutExtension(target))}${extension}`;
+                        return `${lead}${quote}${renamed}${quote}`;
+                    }
+                );
+
+                if (after === before) continue;
+
+                if (changed) changed.after = after;
+                else result.push({ file: source, line, before: original, after });
+            }
         }
+
+        return result;
     }
 
-    return result;
-}
+    /** Write the plan: each changed line, then each move. */
+    static apply(root: string, plan: RenamePlan): void {
+        const files = new Set(plan.changes.map((change) => change.file));
 
-/** Write the plan: each changed line, then each move. */
-export function applyRename(root: string, plan: RenamePlan): void {
-    const files = new Set(plan.changes.map((change) => change.file));
+        for (const file of files) {
+            const lines = readFileSync(join(root, file), "utf8").split("\n");
+            for (const change of plan.changes.filter((each) => each.file === file)) lines[change.line - 1] = change.after;
+            writeFileSync(join(root, file), lines.join("\n"));
+        }
 
-    for (const file of files) {
-        const lines = readFileSync(join(root, file), "utf8").split("\n");
-        for (const change of plan.changes.filter((each) => each.file === file)) lines[change.line - 1] = change.after;
-        writeFileSync(join(root, file), lines.join("\n"));
+        for (const move of plan.moves) renameSync(join(root, move.from), join(root, move.to));
     }
-
-    for (const move of plan.moves) renameSync(join(root, move.from), join(root, move.to));
 }