Merge branch 'trunk' into blueprint-editor

Author: adamziel

packages/playground/cli/src/blueprints-v1/blueprints-v1-handler.ts

@@ -25,6 +25,7 @@ import {
 	type SpawnedWorker,
 	type WorkerType,
 } from '../run-cli';
+import { shouldRenderProgress } from '../utils/progress';
 
 /**
  * Boots Playground CLI workers using Blueprint version 1.
@@ -279,6 +280,9 @@ export class BlueprintsV1Handler {
 		if (this.args.verbosity === LogVerbosity.Quiet.name) {
 			return;
 		}
+		if (!shouldRenderProgress(writeStream)) {
+			return;
+		}
 		if (message === this.lastProgressMessage) {
 			// Avoid repeating the same message
 			return;

packages/playground/cli/src/blueprints-v2/blueprints-v2-handler.ts

@@ -6,6 +6,7 @@ import type {
 } from './worker-thread-v2';
 import type { MessagePort as NodeMessagePort } from 'worker_threads';
 import type { RunCLIArgs, SpawnedWorker, WorkerType } from '../run-cli';
+import { shouldRenderProgress } from '../utils/progress';
 
 /**
  * Boots Playground CLI workers using Blueprint version 2.
@@ -108,6 +109,9 @@ export class BlueprintsV2Handler {
 		message: string,
 		finalUpdate: boolean
 	) {
+		if (!shouldRenderProgress(writeStream)) {
+			return;
+		}
 		if (message === this.lastProgressMessage) {
 			// Avoid repeating the same message
 			return;

packages/playground/cli/src/blueprints-v2/worker-thread-v2.ts

@@ -39,6 +39,7 @@ import type {
 	PhpIniOptions,
 	PHPInstanceCreatedHook,
 } from '@wp-playground/wordpress';
+import { shouldRenderProgress } from '../utils/progress';
 
 async function mountResources(php: PHP, mounts: Mount[]) {
 	for (const mount of mounts) {
@@ -74,7 +75,8 @@ function tracePhpWasm(processId: number, format: string, ...args: any[]) {
 }
 
 /**
- * Force TTY status to preserve ANSI control codes in the output.
+ * Force TTY status to preserve ANSI control codes in the output
+ * when the environment is interactive.
  *
  * This script is spawned as `new Worker()` and process.stdout and process.stderr are
  * WritableWorkerStdio objects. By default, they strip ANSI control codes from the output
@@ -90,6 +92,9 @@ Object.defineProperty(process.stderr, 'isTTY', { value: true });
 const output = {
 	lastWriteWasProgress: false,
 	progress(data: string) {
+		if (!shouldRenderProgress(process.stdout)) {
+			return;
+		}
 		if (!process.stdout.isTTY) {
 			// eslint-disable-next-line no-console
 			console.log(data);

packages/playground/cli/src/run-cli.ts

@@ -88,11 +88,17 @@ export async function parseOptionsAndRunCLI(argsToParse: string[]) {
 		 */
 		const yargsObject = yargs(argsToParse)
 			.usage('Usage: wp-playground <command> [options]')
-			.positional('command', {
-				describe: 'Command to run',
-				choices: ['server', 'run-blueprint', 'build-snapshot'] as const,
-				demandOption: true,
-			})
+			.command('server', 'Start a local WordPress server')
+			.command(
+				'run-blueprint',
+				'Execute a Blueprint without starting a server'
+			)
+			.command(
+				'build-snapshot',
+				'Build a ZIP snapshot of a WordPress site based on a Blueprint'
+			)
+			.demandCommand(1, 'Please specify a command')
+			.strictCommands()
 			.option('outfile', {
 				describe: 'When building, write to this output file.',
 				type: 'string',
@@ -288,6 +294,18 @@ export async function parseOptionsAndRunCLI(argsToParse: string[]) {
 				hidden: true,
 			})
 			.showHelpOnFail(false)
+			.fail((msg, err, yargsInstance) => {
+				if (err) {
+					throw err;
+				}
+				if (msg && msg.includes('Please specify a command')) {
+					yargsInstance.showHelp();
+					console.error('\n' + msg);
+					process.exit(1);
+				}
+				console.error(msg);
+				process.exit(1);
+			})
 			.strictOptions()
 			.check(async (args) => {
 				if (args['skip-wordpress-install'] === true) {

packages/playground/cli/src/utils/progress.ts

@@ -0,0 +1,17 @@
+export function shouldRenderProgress(
+	writeStream?: { isTTY?: boolean } | null
+): boolean {
+	const termIsDumb = (process.env['TERM'] || '').toLowerCase() === 'dumb';
+	const ciFlag = (process.env['CI'] || '').toLowerCase();
+	const runningInCI = ciFlag === '1' || ciFlag === 'true';
+
+	if (termIsDumb || runningInCI) {
+		return false;
+	}
+
+	if (writeStream) {
+		return Boolean(writeStream.isTTY);
+	}
+
+	return true;
+}