Support the WRANGLER_HIDE_BANNER environment variable across Wrangler & C3

Author: penalosa

.changeset/eager-pans-hang.md

@@ -0,0 +1,21 @@
+---
+"wrangler": minor
+---
+
+When the `WRANGLER_HIDE_BANNER` environment variable is provided, Wrangler will no longer display a version banner. This applies to all commands.
+
+For instance, previously running `wrangler docs` would give the following output:
+
+```
+> wrangler docs
+ ⛅️ wrangler 4.47.0
+───────────────────
+Opening a link in your default browser: https://developers.cloudflare.com/workers/wrangler/commands/
+```
+
+With `WRANGLER_HIDE_BANNER`, this is now:
+
+```
+> WRANGLER_HIDE_BANNER=true wrangler docs
+Opening a link in your default browser: https://developers.cloudflare.com/workers/wrangler/commands/
+```

.changeset/funny-eggs-grow.md

@@ -0,0 +1,5 @@
+---
+"create-cloudflare": patch
+---
+
+When `create-cloudflare` runs a Wrangler command (e.g. `wrangler deploy` if the user chooses to deploy during the project creation flow), it will now hide the Wrangler version banner.

packages/create-cloudflare/e2e/tests/cli/cli.test.ts

@@ -464,7 +464,7 @@ describe("Create Cloudflare CLI", () => {
 				);
 				expect(normalizeOutput(output)).toMatchInlineSnapshot(`
 					"create-cloudflare <version>
-					  The create-cloudflare cli (also known as C3) is a command-line tool designed to help you set up and deploy new applications to Cloudflare. In addition to speed, it leverages officially developed templates for Workers and framework-specific setup guides to ensure each new application that you set up follows Cloudflare and any third-party best practices for deployment on the Cloudflare network.
+					  The create-cloudflare CLI (also known as C3) is a command-line tool designed to help you set up and deploy new applications to Cloudflare. In addition to speed, it leverages officially developed templates for Workers and framework-specific setup guides to ensure each new application that you set up follows Cloudflare and any third-party best practices for deployment on the Cloudflare network.
 					USAGE
 					  <USAGE>
 					OPTIONS
@@ -536,7 +536,7 @@ describe("Create Cloudflare CLI", () => {
 				const { output } = await runC3(["--help"], [], logStream);
 				expect(normalizeOutput(output)).toMatchInlineSnapshot(`
 					"create-cloudflare <version>
-					  The create-cloudflare cli (also known as C3) is a command-line tool designed to help you set up and deploy new applications to Cloudflare. In addition to speed, it leverages officially developed templates for Workers and framework-specific setup guides to ensure each new application that you set up follows Cloudflare and any third-party best practices for deployment on the Cloudflare network.
+					  The create-cloudflare CLI (also known as C3) is a command-line tool designed to help you set up and deploy new applications to Cloudflare. In addition to speed, it leverages officially developed templates for Workers and framework-specific setup guides to ensure each new application that you set up follows Cloudflare and any third-party best practices for deployment on the Cloudflare network.
 					USAGE
 					  <USAGE>
 					OPTIONS

packages/create-cloudflare/src/helpers/args.ts

@@ -44,7 +44,7 @@ export type ArgumentsDefinition = {
 
 export const cliDefinition: ArgumentsDefinition = {
 	intro: `
-    The create-cloudflare cli (also known as C3) is a command-line tool designed to help you set up and deploy new applications to Cloudflare. In addition to speed, it leverages officially developed templates for Workers and framework-specific setup guides to ensure each new application that you set up follows Cloudflare and any third-party best practices for deployment on the Cloudflare network.
+    The create-cloudflare CLI (also known as C3) is a command-line tool designed to help you set up and deploy new applications to Cloudflare. In addition to speed, it leverages officially developed templates for Workers and framework-specific setup guides to ensure each new application that you set up follows Cloudflare and any third-party best practices for deployment on the Cloudflare network.
   `,
 	positionals: [
 		{

packages/create-cloudflare/src/helpers/command.ts

@@ -56,11 +56,12 @@ export const runCommand = async (
 			// Don't send metrics data on any wrangler commands if telemetry is disabled in C3
 			// If telemetry is disabled separately for wrangler, wrangler will handle that
 			if (args[0] === "wrangler") {
+				opts.env ??= {};
 				const metrics = readMetricsConfig();
 				if (metrics.c3permission?.enabled === false) {
-					opts.env ??= {};
 					opts.env["WRANGLER_SEND_METRICS"] = "false";
 				}
+				opts.env["WRANGLER_HIDE_BANNER"] = "true";
 			}
 			const abortController = new AbortController();
 			const cmd = spawn(executable, [...args], {

packages/wrangler/src/__tests__/banner.test.ts

@@ -0,0 +1,28 @@
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { useMockIsTTY } from "./helpers/mock-istty";
+import { runWrangler } from "./helpers/run-wrangler";
+
+describe("wrangler banner", () => {
+	const std = mockConsoleMethods();
+	const { setIsTTY } = useMockIsTTY();
+	beforeEach(() => {
+		setIsTTY(true);
+	});
+
+	it("should display the version banner by default", async () => {
+		await runWrangler("--version");
+
+		expect(std.out).toMatchInlineSnapshot(`
+			"
+			 ⛅️ wrangler x.x.x
+			──────────────────"
+		`);
+	});
+
+	it("should hide the version banner when WRANGLER_HIDE_BANNER is present", async () => {
+		vi.stubEnv("WRANGLER_HIDE_BANNER", "true");
+		await runWrangler("--version");
+
+		expect(std.out).toMatchInlineSnapshot(`""`);
+	});
+});

packages/wrangler/src/core/register-yargs-command.ts

@@ -7,6 +7,7 @@ import chalk from "chalk";
 import { fetchResult } from "../cfetch";
 import { createCloudflareClient } from "../cfetch/internal";
 import { readConfig } from "../config";
+import { getWranglerHideBanner } from "../environment-variables/misc-variables";
 import { hasDefinedEnvironments } from "../environments";
 import { run } from "../experimental-flags";
 import { logger } from "../logger";
@@ -107,7 +108,7 @@ function createHandler(def: CommandDefinition, commandName: string) {
 			const shouldPrintBanner = def.behaviour?.printBanner;
 
 			if (
-				/* No defautl behaviour override: show the banner */
+				/* No default behaviour override: show the banner */
 				shouldPrintBanner === undefined ||
 				/* Explicit opt in: show the banner */
 				(typeof shouldPrintBanner === "boolean" &&
@@ -119,14 +120,15 @@ function createHandler(def: CommandDefinition, commandName: string) {
 				await printWranglerBanner();
 			}
 
-			if (def.metadata.deprecated) {
-				logger.warn(def.metadata.deprecatedMessage);
-			}
-			if (def.metadata.statusMessage) {
-				logger.warn(def.metadata.statusMessage);
-			}
+			if (!getWranglerHideBanner()) {
+				if (def.metadata.deprecated) {
+					logger.warn(def.metadata.deprecatedMessage);
+				}
 
-			// TODO(telemetry): send command started event
+				if (def.metadata.statusMessage) {
+					logger.warn(def.metadata.statusMessage);
+				}
+			}
 
 			await def.validateArgs?.(args);
 

packages/wrangler/src/environment-variables/factory.ts

@@ -51,6 +51,8 @@ type VariableNames =
 	| "WRANGLER_LOG_SANITIZE"
 	/** Directory for ND-JSON output files. */
 	| "WRANGLER_OUTPUT_FILE_DIRECTORY"
+	/** Hide the Wrangler version banner */
+	| "WRANGLER_HIDE_BANNER"
 
 	// ## Build & Deployment Configuration
 

packages/wrangler/src/environment-variables/misc-variables.ts

@@ -313,3 +313,11 @@ export const getDisableConfigWatching = getBooleanEnvironmentVariableFactory({
 	variableName: "WRANGLER_CI_DISABLE_CONFIG_WATCHING",
 	defaultValue: false,
 });
+
+/**
+ * Hide the Wrangler version banner and command status (deprecated/experimental) warnings
+ */
+export const getWranglerHideBanner = getBooleanEnvironmentVariableFactory({
+	variableName: "WRANGLER_HIDE_BANNER",
+	defaultValue: false,
+});

packages/wrangler/src/wrangler-banner.ts

@@ -3,6 +3,7 @@ import semiver from "semiver";
 import stripAnsi from "strip-ansi";
 import supportsColor from "supports-color";
 import { version as wranglerVersion } from "../package.json";
+import { getWranglerHideBanner } from "./environment-variables/misc-variables";
 import { logger } from "./logger";
 import { updateCheck } from "./update-check";
 
@@ -13,6 +14,9 @@ const MIN_NODE_VERSION = "20.0.0";
 declare const WRANGLER_PRERELEASE_LABEL: string;
 
 export async function printWranglerBanner(performUpdateCheck = true) {
+	if (getWranglerHideBanner()) {
+		return;
+	}
 	let text =
 		typeof WRANGLER_PRERELEASE_LABEL === "undefined"
 			? ` ⛅️ wrangler ${wranglerVersion}`