@orkestrel/scaffold 0.0.31 → 0.0.32

package/dist/bin/main.js

@@ -3,7 +3,7 @@ import { execFileSync } from "node:child_process";
 import { align, renderTable, strip, stripControls, width } from "@orkestrel/console";
 import { attempt, isRecord, isString, parseJSON } from "@orkestrel/contract";
 import { createMarkdown, flattenText, isTableNode } from "@orkestrel/markdown";
-import { BIN_ENTRY_PATH, CATALOG_AGENT_PATH, CONFORMANCE_TEST_PATH, DEPENDENCY_NAME_PATTERN, ENVIRONMENTS, GLOBAL_SETUP_PATH, GROUPS, GUIDES_TEST_PATH, INTEGRATION_TEST_PATH, MAX_MANIFEST_BYTES, SERVICE_SETUP_PATH, SHOWCASE_CONFIG_PATH, ScaffoldError, blueprintToRootVite, createBlueprint, createCompiler, isScaffoldError, manifestToDependencies, manifestToName, nameToGuide } from "../src/core/index.js";
+import { BIN_ENTRY_PATH, CATALOG_AGENT_PATH, CONFORMANCE_TEST_PATH, DEPENDENCY_NAME_PATTERN, DISTRIBUTION_TEST_PATH, ENVIRONMENTS, GLOBAL_SETUP_PATH, GROUPS, GUIDES_TEST_PATH, INTEGRATION_TEST_PATH, MAX_MANIFEST_BYTES, SERVICE_SETUP_PATH, SHOWCASE_CONFIG_PATH, ScaffoldError, blueprintToDevDependencies, blueprintToRootVite, blueprintToScripts, createBlueprint, createCompiler, isScaffoldError, manifestToDependencies, manifestToName, nameToGuide } from "../src/core/index.js";
 import { createMaterializer, createUpstream, isExactCaseFile, isPhysicalDirectory, isRepository, readFileText, readSnapshot, resolveContainedPath } from "../src/server/index.js";
 import { parseArgs } from "node:util";
 //#region src/bin/constants.ts
@@ -620,13 +620,13 @@ var CLI = class CLI {
 	#inspect(command) {
 		const target = command.target ?? ".";
 		const blueprint = this.#derive(target);
-		const question = this.#projectQuestion(target, blueprint);
+		const questions = this.#targetQuestions(target, blueprint);
 		const materializer = createMaterializer(command.from === void 0 ? void 0 : { host: command.from });
 		try {
 			const [measured] = this.#survey(materializer, blueprint, target, this.#groups(command.groups));
-			const audit = question === void 0 ? measured : {
+			const audit = questions.length === 0 ? measured : {
 				...measured,
-				questions: [...measured.questions, question]
+				questions: [...measured.questions, ...questions]
 			};
 			if (command.json === true) this.#report(audit);
 			else this.#present(audit);
@@ -639,7 +639,7 @@ var CLI = class CLI {
 		const target = command.target ?? ".";
 		const groups = this.#groups(command.groups);
 		const blueprint = this.#derive(target);
-		this.#assertProjects(target, blueprint);
+		this.#assertTarget(target, blueprint);
 		const materializer = createMaterializer(command.from === void 0 ? void 0 : { host: command.from });
 		try {
 			const [audit, plan] = this.#survey(materializer, blueprint, target, groups);
@@ -657,6 +657,7 @@ var CLI = class CLI {
 			if (command.json === true) this.#report(outcome);
 			else {
 				this.#present(terminal);
+				this.#reportReplacements(audit, terminal);
 				this.#say(this.#tally(result));
 			}
 			return auditToExit(terminal);
@@ -691,7 +692,7 @@ var CLI = class CLI {
 		const target = command.target ?? ".";
 		const groups = this.#groups(command.groups);
 		const blueprint = this.#derive(target);
-		this.#assertProjects(target, blueprint);
+		this.#assertTarget(target, blueprint);
 		const repository = this.#repository(target);
 		if (repository.dirty.length > 0 && command.dirty !== true) throw new ScaffoldError("TARGET", `The target at ${target} carries ${String(repository.dirty.length)} uncommitted change${repository.dirty.length === 1 ? "" : "s"}. Commit them, or pass --dirty to waive the refusal.`, {
 			target,
@@ -721,6 +722,7 @@ var CLI = class CLI {
 			if (command.json === true) this.#report(outcome);
 			else {
 				this.#present(terminal);
+				this.#reportReplacements(audit, terminal);
 				this.#recount(outcome);
 				if (online.note !== void 0) this.#warn(online.note);
 			}
@@ -820,6 +822,8 @@ var CLI = class CLI {
 		const declared = manifestToName(manifest);
 		if (declared === void 0) throw new ScaffoldError("TARGET", `The manifest at ${target} declares no package name.`, { target });
 		const bin = resolveContainedPath(target, BIN_ENTRY_PATH);
+		const guides = resolveContainedPath(target, GUIDES_TEST_PATH);
+		const distribution = resolveContainedPath(target, DISTRIBUTION_TEST_PATH);
 		const integration = resolveContainedPath(target, INTEGRATION_TEST_PATH);
 		const conformance = resolveContainedPath(target, CONFORMANCE_TEST_PATH);
 		const service = resolveContainedPath(target, SERVICE_SETUP_PATH);
@@ -830,6 +834,8 @@ var CLI = class CLI {
 			app: this.#probe(target, "app"),
 			dependencies: manifestToDependencies(manifest),
 			bin: bin !== void 0 && isExactCaseFile(bin),
+			guides: guides !== void 0 && isExactCaseFile(guides),
+			distribution: distribution !== void 0 && isExactCaseFile(distribution),
 			integration: integration !== void 0 && isExactCaseFile(integration),
 			conformance: conformance !== void 0 && isExactCaseFile(conformance),
 			service: service !== void 0 && isExactCaseFile(service),
@@ -837,7 +843,7 @@ var CLI = class CLI {
 			showcase: showcase !== void 0 && isExactCaseFile(showcase)
 		});
 	}
-	#scriptProjects(script) {
+	#invocations(script) {
 		const tokens = [];
 		let value = "";
 		let resolved = true;
@@ -912,9 +918,25 @@ var CLI = class CLI {
 			resolved
 		});
 		const projects = [];
+		const scripts = [];
 		for (let index = 0; index < tokens.length; index += 1) {
 			const token = tokens[index];
 			if (token === void 0) return void 0;
+			if (token.value === "npm" && tokens[index + 1]?.value === "run") {
+				const name = tokens[index + 2];
+				if (name === void 0 || !name.resolved || name.value.length === 0 || [
+					"&&",
+					"||",
+					";",
+					"|",
+					"&",
+					"(",
+					")"
+				].includes(name.value)) return void 0;
+				scripts.push(name.value);
+				index += 2;
+				continue;
+			}
 			if (token.value === "--project") {
 				const project = tokens[index + 1];
 				if (project === void 0 || !project.resolved || project.value.length === 0 || [
@@ -938,45 +960,128 @@ var CLI = class CLI {
 			}
 			if (!token.resolved && token.value.includes("--project")) return void 0;
 		}
-		return projects;
+		return {
+			projects,
+			scripts
+		};
 	}
 	#projectQuestion(target, blueprint, writing = false) {
 		const manifest = this.#manifest(target);
-		const guides = resolveContainedPath(target, GUIDES_TEST_PATH);
 		const planned = blueprintToRootVite(blueprint);
 		const parsed = parseJSON(manifest);
-		const scripts = isRecord(parsed) && isRecord(parsed.scripts) ? parsed.scripts : void 0;
+		const scripts = isRecord(parsed) && isRecord(parsed.scripts) ? parsed.scripts : {};
+		const gates = !isRecord(parsed) || parsed.private !== true ? ["test", "prepublishOnly"] : ["test"];
+		const gateNames = gates.join(" or ");
 		const absent = /* @__PURE__ */ new Set();
 		let unresolved = false;
-		if (scripts !== void 0) for (const script of Object.values(scripts)) {
+		for (const script of Object.values(scripts)) {
 			if (!isString(script) || !script.includes("vitest")) continue;
-			const projects = this.#scriptProjects(script);
-			if (projects === void 0) {
+			const invoked = this.#invocations(script);
+			if (invoked === void 0) {
 				unresolved = true;
 				continue;
 			}
-			for (const project of projects) {
-				const guide = project === "guides" && guides !== void 0 && isExactCaseFile(guides);
-				if (!planned.includes(`name: { label: '${project}',`) || project === "guides" && !guide) absent.add(project);
-			}
+			for (const project of invoked.projects) if (!planned.includes(`name: { label: '${project}',`)) absent.add(project);
 		}
-		if (absent.size === 0 && !unresolved) return void 0;
 		const projects = [...absent].sort();
 		if (unresolved) return {
 			field: "projects",
 			message: `The manifest at ${target} contains a Vitest project expression that cannot be resolved statically.${projects.length === 0 ? "" : ` It also names projects the planned configuration does not register: ${projects.join(", ")}.`} ${writing ? "Replace it with a literal --project value or remove the script before using a scaffold writing verb." : "Replace it with a literal --project value before relying on the planned configuration."}`,
 			blocking: false
 		};
-		return {
+		if (projects.length > 0) return {
 			field: "projects",
 			message: writing ? `The manifest at ${target} names ${projects.length === 1 ? "a Vitest project" : "Vitest projects"} the planned configuration does not register: ${projects.join(", ")}. To continue, remove the ${projects.length === 1 ? "script that names it" : "scripts that name them"} or do not use scaffold writing verbs on a workspace that needs ${projects.length === 1 ? "a custom Vitest project" : "custom Vitest projects"}.` : `The manifest at ${target} names ${projects.length === 1 ? "a Vitest project" : "Vitest projects"} the planned configuration does not register: ${projects.join(", ")}. Add ${projects.length === 1 ? "the project" : "each project"} to vite.config.ts or remove the ${projects.length === 1 ? "script that names it" : "scripts that name them"}.`,
 			blocking: false
 		};
+		const expected = blueprintToScripts(blueprint);
+		const expectedLines = /* @__PURE__ */ new Map();
+		for (const [name, script] of Object.entries(expected)) {
+			if (!name.startsWith("test:") || name === "test:probe") continue;
+			const invoked = this.#invocations(script);
+			if (invoked === void 0) continue;
+			for (const project of invoked.projects) {
+				if (project === "probe") continue;
+				const direct = `test:${project}`;
+				const command = expected[direct];
+				if (command !== void 0) expectedLines.set(project, `"${direct}": ${JSON.stringify(command)},`);
+			}
+		}
+		const reachable = /* @__PURE__ */ new Set();
+		const visited = /* @__PURE__ */ new Set();
+		const pending = [...gates];
+		while (pending.length > 0) {
+			const name = pending.shift();
+			if (name === void 0 || visited.has(name)) continue;
+			visited.add(name);
+			const script = scripts[name];
+			if (!isString(script)) continue;
+			const invoked = this.#invocations(script);
+			if (invoked === void 0) {
+				unresolved = true;
+				continue;
+			}
+			for (const project of invoked.projects) reachable.add(project);
+			for (const called of invoked.scripts) if (!visited.has(called)) pending.push(called);
+		}
+		if (unresolved) return {
+			field: "projects",
+			message: `The manifest at ${target} contains a ${gateNames} chain that cannot be resolved statically. ${writing ? "Replace it with literal npm run script names before using a scaffold writing verb." : "Replace it with literal npm run script names before relying on the planned configuration."}`,
+			blocking: false
+		};
+		const missing = [...expectedLines].filter(([project]) => !reachable.has(project)).sort(([left], [right]) => left.localeCompare(right));
+		if (missing.length === 0) return void 0;
+		const names = missing.map(([project]) => project);
+		const unscripted = missing.filter(([project]) => !isString(scripts[`test:${project}`]));
+		const ungated = missing.filter(([project]) => isString(scripts[`test:${project}`]));
+		const remedies = [];
+		if (ungated.length > 0) {
+			const declared = ungated.map(([project]) => `test:${project}`);
+			remedies.push(`${declared.join(", ")} ${declared.length === 1 ? "is" : "are"} already declared, so the gate is missing rather than the script: invoke ${declared.length === 1 ? "it" : "each of them"} by name from the ${gateNames} chain.`);
+		}
+		if (unscripted.length > 0) {
+			const lines = unscripted.map(([, line]) => line);
+			remedies.push(`${writing ? "To continue, add" : "Add"} ${lines.length === 1 ? "this exact script line" : "these exact script lines"} to package.json: ${lines.join(" ")}`);
+		}
+		return {
+			field: "projects",
+			message: `The manifest at ${target} does not reach ${names.length === 1 ? "a Vitest project" : "Vitest projects"} the planned configuration registers: ${names.join(", ")}. No chain from ${gateNames} invokes ${names.length === 1 ? "it" : "them"}. ${remedies.join(" ")}`,
+			blocking: false
+		};
 	}
-	#assertProjects(target, blueprint) {
-		const question = this.#projectQuestion(target, blueprint, true);
-		if (question === void 0) return;
-		throw new ScaffoldError("TARGET", question.message, { target });
+	#dependencyQuestion(target, blueprint, writing = false) {
+		const parsed = parseJSON(this.#manifest(target));
+		if (!isRecord(parsed)) return void 0;
+		const malformed = ["dependencies", "devDependencies"].filter((section) => parsed[section] !== void 0 && !isRecord(parsed[section]));
+		if (malformed.length > 0) return {
+			field: "dependencies",
+			message: `The manifest at ${target} declares ${malformed.join(" and ")} as ${malformed.length === 1 ? "a value" : "values"} that ${malformed.length === 1 ? "is" : "are"} not ${malformed.length === 1 ? "an object" : "objects"}. Replace ${malformed.length === 1 ? "it" : "them"} with ${malformed.length === 1 ? "an object" : "objects"} before ${writing ? "using a scaffold writing verb" : "relying on the planned dependency set"}.`,
+			blocking: false
+		};
+		const dependencies = isRecord(parsed.dependencies) ? parsed.dependencies : {};
+		const development = isRecord(parsed.devDependencies) ? parsed.devDependencies : {};
+		const missing = Object.entries(blueprintToDevDependencies(blueprint)).filter(([name]) => !Object.hasOwn(dependencies, name) && !Object.hasOwn(development, name)).sort(([left], [right]) => left.localeCompare(right));
+		if (missing.length === 0) return void 0;
+		const names = missing.map(([name]) => name);
+		const lines = missing.map(([name, range]) => `${JSON.stringify(name)}: ${JSON.stringify(range)},`);
+		return {
+			field: "dependencies",
+			message: `The manifest at ${target} does not declare ${names.length === 1 ? "a planned dependency" : "planned dependencies"}: ${names.join(", ")}. ${writing ? "To continue, add" : "Add"} ${lines.length === 1 ? "this exact dependency line" : "these exact dependency lines"} to dependencies or devDependencies in package.json: ${lines.join(" ")}`,
+			blocking: false
+		};
+	}
+	#targetQuestions(target, blueprint, writing = false) {
+		const questions = [];
+		const project = this.#projectQuestion(target, blueprint, writing);
+		if (project !== void 0) questions.push(project);
+		const dependency = this.#dependencyQuestion(target, blueprint, writing);
+		if (dependency !== void 0) questions.push(dependency);
+		return questions;
+	}
+	#assertTarget(target, blueprint) {
+		const questions = this.#targetQuestions(target, blueprint, true);
+		if (questions.length === 0) return;
+		throw new ScaffoldError("TARGET", questions.map((question) => question.message).join(" "), { target });
 	}
 	#manifest(target) {
 		const manifest = readFileText(target, "package.json", MAX_MANIFEST_BYTES);
@@ -1100,6 +1205,22 @@ var CLI = class CLI {
 		}
 		this.#say(auditToSummary(audit));
 	}
+	#reportReplacements(before, after) {
+		const terminal = new Map(after.findings.map((finding) => [finding.path, finding]));
+		for (const finding of before.findings) {
+			if (finding.drift !== "stale") continue;
+			const current = terminal.get(finding.path);
+			if (current?.drift !== "aligned" || current.observed === void 0) continue;
+			const previousLines = Buffer.from(finding.observed, "hex").toString("utf8").split(/\r\n|\r|\n/u).length;
+			const delta = Buffer.from(current.observed, "hex").toString("utf8").split(/\r\n|\r|\n/u).length - previousLines;
+			if (delta === 0) {
+				this.#say(`${finding.path} replaced (0-line delta).`);
+				continue;
+			}
+			const count = Math.abs(delta);
+			this.#say(`${finding.path} replaced (${String(count)} line${count === 1 ? "" : "s"} ${delta > 0 ? "added" : "removed"}).`);
+		}
+	}
 	#recount(result) {
 		this.#say(this.#tally(result));
 		this.#say(`${String(result.entries.length)} published, ${String(result.mirrors.filter((mirror) => mirror.lookup === "found").length)} guide${result.mirrors.length === 1 ? "" : "s"} fetched, ${String(result.dropped.length)} no longer listed.`);