@format.dev/cli 0.1.1 → 0.1.2

package/dist/index.mjs

@@ -250,7 +250,7 @@ var cli_spec_default = { commands: [
 
 //#endregion
 //#region src/versioning/js-version.ts
-const jsVersion = "0.1.1";
+const jsVersion = "0.1.2";
 
 //#endregion
 //#region src/versioning/registry.ts
@@ -272,11 +272,43 @@ async function fetchLatestVersion() {
 	return data.version;
 }
 
+//#endregion
+//#region src/versioning/changelog.ts
+const CHANGELOG_URL = "https://format.dev/changelog";
+const CHANGELOG_INDEX_URL = process.env.FMT_CHANGELOG_INDEX_URL ?? "https://format.dev/changelog.json";
+const FETCH_TIMEOUT_MS = 3e3;
+function changelogEntriesBetween(args) {
+	const { entries, fromVersion, toVersion } = args;
+	return entries.filter((entry) => isNewer(entry.version, fromVersion) && !isNewer(entry.version, toVersion)).sort((a, b) => isNewer(a.version, b.version) ? 1 : -1);
+}
+async function fetchChangelogIndex() {
+	const controller = new AbortController();
+	const timeout = setTimeout(() => controller.abort(), FETCH_TIMEOUT_MS);
+	try {
+		const response = await fetch(CHANGELOG_INDEX_URL, { signal: controller.signal });
+		if (!response.ok) throw new Error(`Changelog index returned ${response.status}`);
+		return (await response.json()).entries;
+	} finally {
+		clearTimeout(timeout);
+	}
+}
+async function changelogLines(args) {
+	const { fromVersion, toVersion, fetchEntries = fetchChangelogIndex } = args;
+	const entries = await fetchEntries().catch(() => null);
+	if (!entries) return [`See what's changed: ${CHANGELOG_URL}`];
+	const inRange = changelogEntriesBetween({
+		entries,
+		fromVersion,
+		toVersion
+	});
+	if (inRange.length === 0) return [];
+	return [`What's changed since ${fromVersion}:`, ...inRange.map((entry) => `  ${entry.version}  ${entry.url}`)];
+}
+
 //#endregion
 //#region src/versioning/update-check.ts
 const CACHE_FILE_NAME = "update-check.json";
 const CACHE_MAX_AGE_MS = 1440 * 60 * 1e3;
-const CHANGELOG_URL = "https://format.dev/changelog";
 function cacheDir() {
 	const home = os.homedir();
 	if (process.env.XDG_CACHE_HOME) return join(process.env.XDG_CACHE_HOME, "format");
@@ -599,11 +631,19 @@ function installArgs(packageManager, packages, dev) {
 	switch (packageManager) {
 		case "npm": return [
 			"install",
+			"--save-exact",
 			...dev ? ["--save-dev"] : [],
 			...packages
 		];
+		case "pnpm": return [
+			"add",
+			"--save-exact",
+			...saveFlag ? [saveFlag] : [],
+			...packages
+		];
 		default: return [
 			"add",
+			"--exact",
 			...saveFlag ? [saveFlag] : [],
 			...packages
 		];
@@ -1360,6 +1400,94 @@ async function newProjectCommand(cwd, providedDirectory, options) {
 	}
 }
 
+//#endregion
+//#region src/versioning/cli-package.ts
+const CLI_PACKAGE_NAME$1 = "@format.dev/cli";
+async function readCliPackageVersion() {
+	let dir = dirname(fileURLToPath(import.meta.url));
+	for (;;) {
+		const candidate = join(dir, "package.json");
+		if (existsSync(candidate)) {
+			const manifest = JSON.parse(await fs.readFile(candidate, "utf8"));
+			if (manifest.name === CLI_PACKAGE_NAME$1) return manifest.version;
+		}
+		const parent = dirname(dir);
+		if (parent === dir) throw new Error(`Could not find the ${CLI_PACKAGE_NAME$1} package.json above ${fileURLToPath(import.meta.url)}`);
+		dir = parent;
+	}
+}
+
+//#endregion
+//#region src/versioning/handoff.ts
+const HANDOFF_ENV = "FMT_UPDATE_HANDOFF";
+const CLI_PACKAGE_NAME = "@format.dev/cli";
+function readHandoffFromVersion() {
+	return process.env[HANDOFF_ENV] ?? null;
+}
+function environmentWithoutHandoff() {
+	const { [HANDOFF_ENV]: _handoff, ...environment } = process.env;
+	return environment;
+}
+async function handOffUpdate(args) {
+	const { targetVersion, fromVersion, cwd } = args;
+	const commandArgs = [
+		"exec",
+		"--yes",
+		`--package=${CLI_PACKAGE_NAME}@${targetVersion}`,
+		"--",
+		"format",
+		"update",
+		targetVersion
+	];
+	return new Promise((resolvePromise, rejectPromise) => {
+		const child = spawn("npm", commandArgs, {
+			cwd,
+			stdio: "inherit",
+			shell: process.platform === "win32",
+			env: {
+				...process.env,
+				[HANDOFF_ENV]: fromVersion ?? "none"
+			}
+		});
+		child.on("error", (error) => {
+			rejectPromise(new CliError(`Failed to run the Format ${targetVersion} CLI: ${error.message}`));
+		});
+		child.on("exit", (code) => {
+			resolvePromise(code ?? 1);
+		});
+	});
+}
+
+//#endregion
+//#region src/versioning/fresh-install.ts
+const FORMAT_SCOPE = "@format.dev/";
+const DEPENDENCY_SECTIONS = [
+	"dependencies",
+	"devDependencies",
+	"optionalDependencies"
+];
+function withoutFormatDependencies(manifest) {
+	const copy = { ...manifest };
+	for (const section of DEPENDENCY_SECTIONS) {
+		const entries = manifest[section];
+		if (!entries) continue;
+		copy[section] = Object.fromEntries(Object.entries(entries).filter(([name, version]) => !name.startsWith(FORMAT_SCOPE) || version.startsWith("workspace:")));
+	}
+	return copy;
+}
+async function installWithFreshFormatTree(args) {
+	const { packageJsonPath, install } = args;
+	const targetSource = await fs.readFile(packageJsonPath, "utf8");
+	const withoutFormat = withoutFormatDependencies(JSON.parse(targetSource));
+	try {
+		await fs.writeFile(packageJsonPath, `${JSON.stringify(withoutFormat, null, "	")}\n`, "utf8");
+		await install();
+	} finally {
+		await fs.writeFile(packageJsonPath, targetSource, "utf8");
+	}
+	await install();
+}
+
 //#endregion
 //#region src/cli/commands/update.ts
 async function updateCommand(cwd, target) {
@@ -1368,6 +1496,13 @@ async function updateCommand(cwd, target) {
 		target,
 		pinnedVersion: state.pinnedVersion
 	});
+	const cliVersion = await readCliPackageVersion();
+	const handoffFromVersion = readHandoffFromVersion();
+	if (handoffFromVersion === null && cliVersion !== targetVersion) return handOffUpdate({
+		targetVersion,
+		fromVersion: state.pinnedVersion,
+		cwd: state.projectDir
+	});
 	if (targetVersion !== state.pinnedVersion) {
 		await writeConfigVersion({
 			filepath: state.configFile.filepath,
@@ -1392,13 +1527,27 @@ async function updateCommand(cwd, target) {
 	const { command, args } = installCommand(packageManager);
 	console.log("");
 	console.log(`Installing with ${packageManager}...`);
-	await runInstall({
-		command,
-		args,
-		cwd: state.projectDir
+	await installWithFreshFormatTree({
+		packageJsonPath: state.packageJsonPath,
+		install: () => runInstall({
+			command,
+			args,
+			cwd: state.projectDir
+		})
 	});
 	console.log("");
 	console.log(`Done. Your project is on Format ${targetVersion}.`);
+	const fromVersion = handoffFromVersion ?? state.pinnedVersion;
+	if (fromVersion !== null && fromVersion !== "none" && fromVersion !== targetVersion) {
+		const lines = await changelogLines({
+			fromVersion,
+			toVersion: targetVersion
+		});
+		if (lines.length > 0) {
+			console.log("");
+			lines.forEach((line) => console.log(line));
+		}
+	}
 	return 0;
 }
 async function resolveTargetVersion(args) {
@@ -1417,7 +1566,8 @@ async function runInstall(args) {
 		const child = spawn(command, commandArgs, {
 			cwd,
 			stdio: "inherit",
-			shell: process.platform === "win32"
+			shell: process.platform === "win32",
+			env: environmentWithoutHandoff()
 		});
 		child.on("error", (error) => {
 			rejectPromise(new CliError(`Failed to run ${command} install: ${error.message}`));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@format.dev/cli",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "license": "MIT",
   "description": "The Format CLI: run Studio, compile documents, and keep Format packages in lockstep",
   "author": "the format.dev developers",
@@ -72,8 +72,8 @@
     "verdaccio": "^6.8.0",
     "vitest": "^4.0.18",
     "vue": "^3.5.25",
-    "@format.dev/vue": "0.1.1",
-    "@format.dev/react": "0.1.1"
+    "@format.dev/vue": "0.1.2",
+    "@format.dev/react": "0.1.2"
   },
   "engines": {
     "node": ">=22.12.0"