feat: notify users when they are running C3 in experimental mode (#7506)

Author: dario-piotrowicz

.changeset/smooth-vans-share.md

@@ -0,0 +1,5 @@
+---
+"create-cloudflare": patch
+---
+
+feat: notify users when they are running C3 in experimental mode

packages/create-cloudflare/src/__tests__/dialog.test.ts

@@ -15,33 +15,69 @@ describe("dialog helpers", () => {
 		process.stdout.columns = originalColumns;
 	});
 
-	test("printWelcomeMessage with telemetry disabled", () => {
-		printWelcomeMessage("0.0.0", false);
+	describe("printWelcomeMessage", () => {
+		test("with telemetry disabled", () => {
+			printWelcomeMessage("0.0.0", false, {});
 
-		expect(normalizeOutput(std.out)).toMatchInlineSnapshot(`
-			"────────────────────────────────────────────────────────────
-			👋 Welcome to create-cloudflare v0.0.0!
-			🧡 Let's get started.
-			────────────────────────────────────────────────────────────
+			expect(normalizeOutput(std.out)).toMatchInlineSnapshot(`
+				"────────────────────────────────────────────────────────────
+				👋 Welcome to create-cloudflare v0.0.0!
+				🧡 Let's get started.
+				────────────────────────────────────────────────────────────
 
-			"
-		`);
-	});
+				"
+			`);
+		});
+
+		test("with telemetry enabled", () => {
+			printWelcomeMessage("0.0.0", true, {});
+
+			expect(normalizeOutput(std.out)).toMatchInlineSnapshot(`
+				"────────────────────────────────────────────────────────────
+				👋 Welcome to create-cloudflare v0.0.0!
+				🧡 Let's get started.
+				📊 Cloudflare collects telemetry about your usage of Create-Cloudflare.
 
-	test("printWelcomeMessage with telemetry enabled", () => {
-		printWelcomeMessage("0.0.0", true);
+				Learn more at: https://github.com/cloudflare/workers-sdk/blob/main/packages/create-cloudflare/telemetry.md
+				────────────────────────────────────────────────────────────
 
-		expect(normalizeOutput(std.out)).toMatchInlineSnapshot(`
-			"────────────────────────────────────────────────────────────
-			👋 Welcome to create-cloudflare v0.0.0!
-			🧡 Let's get started.
-			📊 Cloudflare collects telemetry about your usage of Create-Cloudflare.
+				"
+			`);
+		});
+
+		test("with telemetry disabled in experimental mode", () => {
+			printWelcomeMessage("0.0.0", false, { experimental: true });
 
-			Learn more at: https://github.com/cloudflare/workers-sdk/blob/main/packages/create-cloudflare/telemetry.md
-			────────────────────────────────────────────────────────────
+			expect(normalizeOutput(std.out)).toMatchInlineSnapshot(`
+				"────────────────────────────────────────────────────────────
+				👋 Welcome to create-cloudflare v0.0.0!
+				🧡 Let's get started.
 
-			"
-		`);
+				🧪 Running in experimental mode
+				────────────────────────────────────────────────────────────
+
+				"
+			`);
+		});
+
+		test("with telemetry enabled in experimental mode", () => {
+			printWelcomeMessage("0.0.0", true, { experimental: true });
+
+			expect(normalizeOutput(std.out)).toMatchInlineSnapshot(`
+				"────────────────────────────────────────────────────────────
+				👋 Welcome to create-cloudflare v0.0.0!
+				🧡 Let's get started.
+
+				🧪 Running in experimental mode
+
+				📊 Cloudflare collects telemetry about your usage of Create-Cloudflare.
+
+				Learn more at: https://github.com/cloudflare/workers-sdk/blob/main/packages/create-cloudflare/telemetry.md
+				────────────────────────────────────────────────────────────
+
+				"
+			`);
+		});
 	});
 
 	describe("printSummary", () => {

packages/create-cloudflare/src/cli.ts

@@ -102,7 +102,7 @@ export const runLatest = async () => {
 
 // Entrypoint to c3
 export const runCli = async (args: Partial<C3Args>) => {
-	printBanner();
+	printBanner(args);
 
 	const ctx = await createContext(args);
 
@@ -186,8 +186,8 @@ const deploy = async (ctx: C3Context) => {
 	endSection("Done");
 };
 
-const printBanner = () => {
-	printWelcomeMessage(version, reporter.isEnabled);
+const printBanner = (args: Partial<C3Args>) => {
+	printWelcomeMessage(version, reporter.isEnabled, args);
 	startSection(`Create an application with Cloudflare`, "Step 1 of 3");
 };
 

packages/create-cloudflare/src/dialog.ts

@@ -3,7 +3,7 @@ import { hyperlink, logRaw, shapes, stripAnsi } from "@cloudflare/cli";
 import { bgGreen, blue, gray } from "@cloudflare/cli/colors";
 import { quoteShellArgs } from "helpers/command";
 import { detectPackageManager } from "helpers/packageManagers";
-import type { C3Context } from "types";
+import type { C3Args, C3Context } from "types";
 
 /**
  * Wrap the lines with a border and inner padding
@@ -27,18 +27,27 @@ export function createDialog(lines: string[]) {
 export function printWelcomeMessage(
 	version: string,
 	telemetryEnabled: boolean,
+	args: Partial<C3Args>,
 ) {
 	const lines = [
 		`👋 Welcome to create-cloudflare v${version}!`,
 		`🧡 Let's get started.`,
 	];
 
+	if (args.experimental) {
+		lines.push("", blue`🧪 Running in experimental mode`);
+	}
+
 	if (telemetryEnabled) {
+		if (args.experimental) {
+			lines.push("");
+		}
+
 		const telemetryDocsUrl = `https://github.com/cloudflare/workers-sdk/blob/main/packages/create-cloudflare/telemetry.md`;
 
 		lines.push(
 			`📊 Cloudflare collects telemetry about your usage of Create-Cloudflare.`,
-			``,
+			"",
 			`Learn more at: ${blue.underline(hyperlink(telemetryDocsUrl))}`,
 		);
 	}