@multiplatform.one/cli 7.34.0 → 7.34.1

package/lib/bin/multiplatformOne.mjs

@@ -4,6 +4,7 @@ import { adoptApp } from "../commands/adoptApp.mjs";
 import { generateDoctypeTypes, typesDrift } from "../commands/doctypeTypes.mjs";
 import { discoverE2EApp, runE2ESession } from "../commands/e2e.mjs";
 import { SINGLETON_APPS, init } from "../commands/init.mjs";
+import { runRuff } from "../commands/ruff.mjs";
 import { updateApp } from "../commands/updateApp.mjs";
 import fsSync from "node:fs";
 import path from "node:path";
@@ -466,15 +467,10 @@ async function ruffStep(mode) {
 	const frappeApps = path.join(projectRoot, "apps", "frappe", "apps");
 	if (!fsSync.existsSync(frappeApps)) return false;
 	console.log(`\n── ${mode === "format" ? "ruff format" : "ruff check"} (Python) ──`);
-	try {
-		await spawn("ruff", [mode, frappeApps], {
-			stdio: "inherit",
-			cwd: projectRoot
-		});
-		return false;
-	} catch {
-		return true;
-	}
+	const reason = await runRuff(mode, path.relative(projectRoot, frappeApps), projectRoot);
+	if (reason === void 0) return false;
+	console.error(reason);
+	return true;
 }
 program.command("format").description("format all supported files (TS, Python, etc.) via turbo").action(async () => {
 	await spawn("turbo", [

package/lib/commands/ruff.mjs

@@ -0,0 +1,52 @@
+import spawn from "nano-spawn";
+
+//#region src/commands/ruff.ts
+const pinHint = "ruff is pinned in .tool-versions; `make configure` installs it through mise or asdf";
+function errorDetail(error) {
+	const e = error ?? {};
+	return {
+		code: e.cause?.code,
+		exitCode: e.exitCode,
+		signalName: e.signalName,
+		stderr: e.stderr?.trim() || void 0,
+		message: e.cause?.message ?? e.message ?? String(error)
+	};
+}
+/** Why `ruff --version` did not answer, as one line for the lint output. */
+function ruffStartFailure(error) {
+	const d = errorDetail(error);
+	if (d.code === "ENOENT") return `ruff is not on PATH. ${pinHint}.`;
+	return `ruff did not start: ${d.stderr ?? d.message}. ${pinHint}.`;
+}
+/** Why `ruff <mode>` failed once it had started, as one line for the lint output. */
+function ruffRunFailure(mode, target, error) {
+	const d = errorDetail(error);
+	if (d.signalName) return `ruff ${mode} was killed by ${d.signalName}.`;
+	if (d.exitCode === 1 && mode === "check") return `ruff check found problems in ${target} (listed above).`;
+	if (d.exitCode !== void 0) return `ruff ${mode} exited ${d.exitCode}, a configuration or usage error (see above).`;
+	return `ruff ${mode} failed: ${d.message}.`;
+}
+/**
+* Run ruff format or check on `target`, first proving ruff starts so a missing
+* or broken install is reported as that instead of as a lint failure. Returns
+* the reason it failed, or undefined when it passed.
+*/
+async function runRuff(mode, target, cwd, spawn$1 = spawn) {
+	try {
+		await spawn$1("ruff", ["--version"], { cwd });
+	} catch (error) {
+		return ruffStartFailure(error);
+	}
+	try {
+		await spawn$1("ruff", [mode, target], {
+			stdio: "inherit",
+			cwd
+		});
+		return;
+	} catch (error) {
+		return ruffRunFailure(mode, target, error);
+	}
+}
+
+//#endregion
+export { ruffRunFailure, ruffStartFailure, runRuff };

package/lib/source.json

@@ -1,5 +1,5 @@
 {
-  "cliVersion": "7.34.0",
+  "cliVersion": "7.34.1",
   "url": "https://git.corp.bitspur.com/multiplatform.one/mpo.git",
-  "sha": "7a021d731267c89cdb845ce1edf52cb53e950280"
+  "sha": "a7d02c570fb3b11e285519fcab2cf9065ffbd316"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiplatform.one/cli",
-  "version": "7.34.0",
+  "version": "7.34.1",
   "description": "multiplatform.one cli — mpo init clones and prunes the monorepo, mpo update merges it back",
   "keywords": [
     "create-multiplatform-app",
@@ -56,7 +56,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@multiplatform.one/utils": "7.34.0",
+    "@multiplatform.one/utils": "7.34.1",
     "commander": "^14.0.3",
     "dotenv": "^17.4.2",
     "inquirer": "^13.4.2",

package/src/bin/multiplatformOne.ts

@@ -22,6 +22,7 @@ import { generateDoctypeTypes, typesDrift } from "../commands/doctypeTypes";
 import { discoverE2EApp, runE2ESession } from "../commands/e2e";
 import { SINGLETON_APPS, init } from "../commands/init";
 import { INIT_APP_PIECES } from "../commands/pieces";
+import { runRuff } from "../commands/ruff";
 import { updateApp } from "../commands/updateApp";
 
 const projectRoot = lookupProjectRoot();
@@ -715,15 +716,10 @@ async function ruffStep(mode: "format" | "check"): Promise<boolean> {
   if (!fsSync.existsSync(frappeApps)) return false;
   const label = mode === "format" ? "ruff format" : "ruff check";
   console.log(`\n── ${label} (Python) ──`);
-  try {
-    await spawn("ruff", [mode, frappeApps], {
-      stdio: "inherit",
-      cwd: projectRoot,
-    });
-    return false;
-  } catch {
-    return true;
-  }
+  const reason = await runRuff(mode, path.relative(projectRoot, frappeApps), projectRoot);
+  if (reason === undefined) return false;
+  console.error(reason);
+  return true;
 }
 
 program

package/src/commands/ruff.spec.ts

@@ -0,0 +1,46 @@
+import nanoSpawn from "nano-spawn";
+import { describe, expect, it } from "vitest";
+import { runRuff } from "./ruff";
+
+type Spawn = typeof nanoSpawn;
+
+// Runs a real subprocess in place of ruff, so the errors are nano-spawn's own.
+function standIn(script: (args: readonly string[]) => string): Spawn {
+  return ((_file: string, args: readonly string[] = [], options = {}) =>
+    nanoSpawn("sh", ["-c", script(args)], options)) as Spawn;
+}
+
+describe("runRuff (MPO-497)", () => {
+  it("names a missing ruff and the pin that provides it", async () => {
+    const missing = ((_file: string, args: readonly string[] = [], options = {}) =>
+      nanoSpawn("mpo-497-no-such-ruff", [...args], options)) as Spawn;
+    const reason = await runRuff("check", "apps/frappe/apps", process.cwd(), missing);
+    expect(reason).toMatch(/^ruff is not on PATH\./);
+    expect(reason).toContain(".tool-versions");
+    expect(reason).toContain("make configure");
+  });
+
+  it("reports a ruff that will not start with what it printed", async () => {
+    const shim = standIn(() => "echo 'mise ERROR No version is set for shim: ruff' >&2; exit 1");
+    const reason = await runRuff("check", "apps/frappe/apps", process.cwd(), shim);
+    expect(reason).toBe(
+      "ruff did not start: mise ERROR No version is set for shim: ruff. ruff is pinned in .tool-versions; `make configure` installs it through mise or asdf.",
+    );
+  });
+
+  it("separates findings from a configuration error", async () => {
+    const findings = standIn((args) => (args[0] === "--version" ? "true" : "exit 1"));
+    expect(await runRuff("check", "apps/frappe/apps", process.cwd(), findings)).toBe(
+      "ruff check found problems in apps/frappe/apps (listed above).",
+    );
+    const broken = standIn((args) => (args[0] === "--version" ? "true" : "exit 2"));
+    expect(await runRuff("check", "apps/frappe/apps", process.cwd(), broken)).toBe(
+      "ruff check exited 2, a configuration or usage error (see above).",
+    );
+  });
+
+  it("passes when ruff starts and exits 0", async () => {
+    const clean = standIn(() => "true");
+    expect(await runRuff("check", "apps/frappe/apps", process.cwd(), clean)).toBeUndefined();
+  });
+});

package/src/commands/ruff.ts

@@ -0,0 +1,74 @@
+import nanoSpawn from "nano-spawn";
+
+export type RuffMode = "format" | "check";
+
+type Spawn = typeof nanoSpawn;
+
+const pinHint =
+  "ruff is pinned in .tool-versions; `make configure` installs it through mise or asdf";
+
+function errorDetail(error: unknown): {
+  code?: string;
+  exitCode?: number;
+  signalName?: string;
+  stderr?: string;
+  message: string;
+} {
+  const e = (error ?? {}) as {
+    cause?: { code?: string; message?: string };
+    exitCode?: number;
+    signalName?: string;
+    stderr?: string;
+    message?: string;
+  };
+  return {
+    code: e.cause?.code,
+    exitCode: e.exitCode,
+    signalName: e.signalName,
+    stderr: e.stderr?.trim() || undefined,
+    message: e.cause?.message ?? e.message ?? String(error),
+  };
+}
+
+/** Why `ruff --version` did not answer, as one line for the lint output. */
+export function ruffStartFailure(error: unknown): string {
+  const d = errorDetail(error);
+  if (d.code === "ENOENT") return `ruff is not on PATH. ${pinHint}.`;
+  const why = d.stderr ?? d.message;
+  return `ruff did not start: ${why}. ${pinHint}.`;
+}
+
+/** Why `ruff <mode>` failed once it had started, as one line for the lint output. */
+export function ruffRunFailure(mode: RuffMode, target: string, error: unknown): string {
+  const d = errorDetail(error);
+  if (d.signalName) return `ruff ${mode} was killed by ${d.signalName}.`;
+  if (d.exitCode === 1 && mode === "check")
+    return `ruff check found problems in ${target} (listed above).`;
+  if (d.exitCode !== undefined)
+    return `ruff ${mode} exited ${d.exitCode}, a configuration or usage error (see above).`;
+  return `ruff ${mode} failed: ${d.message}.`;
+}
+
+/**
+ * Run ruff format or check on `target`, first proving ruff starts so a missing
+ * or broken install is reported as that instead of as a lint failure. Returns
+ * the reason it failed, or undefined when it passed.
+ */
+export async function runRuff(
+  mode: RuffMode,
+  target: string,
+  cwd: string,
+  spawn: Spawn = nanoSpawn,
+): Promise<string | undefined> {
+  try {
+    await spawn("ruff", ["--version"], { cwd });
+  } catch (error) {
+    return ruffStartFailure(error);
+  }
+  try {
+    await spawn("ruff", [mode, target], { stdio: "inherit", cwd });
+    return undefined;
+  } catch (error) {
+    return ruffRunFailure(mode, target, error);
+  }
+}

package/types/bin/multiplatformOne.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"multiplatformOne.d.ts","sourceRoot":"","sources":["../../src/bin/multiplatformOne.ts"],"names":[],"mappings":"AA6FA,gHAAgH;AAChH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,kGAAkG;IAClG,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gGAAgG;IAChG,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC"}
+{"version":3,"file":"multiplatformOne.d.ts","sourceRoot":"","sources":["../../src/bin/multiplatformOne.ts"],"names":[],"mappings":"AA8FA,gHAAgH;AAChH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,kGAAkG;IAClG,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gGAAgG;IAChG,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC"}

package/types/commands/ruff.d.ts

@@ -0,0 +1,15 @@
+import nanoSpawn from "nano-spawn";
+export type RuffMode = "format" | "check";
+type Spawn = typeof nanoSpawn;
+/** Why `ruff --version` did not answer, as one line for the lint output. */
+export declare function ruffStartFailure(error: unknown): string;
+/** Why `ruff <mode>` failed once it had started, as one line for the lint output. */
+export declare function ruffRunFailure(mode: RuffMode, target: string, error: unknown): string;
+/**
+ * Run ruff format or check on `target`, first proving ruff starts so a missing
+ * or broken install is reported as that instead of as a lint failure. Returns
+ * the reason it failed, or undefined when it passed.
+ */
+export declare function runRuff(mode: RuffMode, target: string, cwd: string, spawn?: Spawn): Promise<string | undefined>;
+export {};
+//# sourceMappingURL=ruff.d.ts.map

package/types/commands/ruff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ruff.d.ts","sourceRoot":"","sources":["../../src/commands/ruff.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE1C,KAAK,KAAK,GAAG,OAAO,SAAS,CAAC;AA4B9B,4EAA4E;AAC5E,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAKvD;AAED,qFAAqF;AACrF,wBAAgB,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAQrF;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,KAAK,GAAE,KAAiB,GACvB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAY7B"}