Expose global flags from experimental_getWranglerCommands() (#10424)

* axpose global flags

* remove -j flag

* Create nervous-goats-sniff.md

* Remove unnecessary experimental JSON config flag

* Update TSDoc comment for experimental_getWranglerCommands return type

Addresses GitHub comment from dario-piotrowicz asking to update the
@returns documentation to reflect the new return type that includes
both registry and globalFlags properties.

Co-Authored-By: [email protected] <[email protected]>

* Fix metrics tests after -j flag removal

Update test expectations to match the new error message after
the experimental JSON config flag was removed in 18b712e.

Co-Authored-By: [email protected] <[email protected]>

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Author: penalosa

.changeset/dirty-students-scream.md

@@ -0,0 +1,7 @@
+---
+"playground-preview-worker": patch
+"turbo-r2-archive": patch
+"wrangler": patch
+---
+
+Remove the `--experimental-json-config`/`-j` flag, which is no longer required.

.changeset/nervous-goats-sniff.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+Expose global flags from `experimental_getWranglerCommands()`

packages/playground-preview-worker/package.json

@@ -8,9 +8,9 @@
 		"build-middleware:loader": "pnpm dlx esbuild ../wrangler/templates/middleware/loader-modules.ts --outfile=src/middleware/loader.module.template",
 		"check:lint": "eslint . --max-warnings=0",
 		"check:type": "tsc",
-		"deploy": "wrangler -j deploy",
-		"deploy:testing": "wrangler -j deploy -e testing",
-		"start": "wrangler -j dev",
+		"deploy": "wrangler deploy",
+		"deploy:testing": "wrangler deploy -e testing",
+		"start": "wrangler dev",
 		"test:e2e": "vitest run"
 	},
 	"dependencies": {

packages/turbo-r2-archive/package.json

@@ -11,10 +11,10 @@
 		"remote cache"
 	],
 	"scripts": {
-		"build": "wrangler deploy -j --dry-run --outdir=./dist",
+		"build": "wrangler deploy --dry-run --outdir=./dist",
 		"check:lint": "eslint .  --max-warnings=0",
-		"deploy": "wrangler deploy -j",
-		"start": "wrangler dev -j",
+		"deploy": "wrangler deploy",
+		"start": "wrangler dev",
 		"type:check": "tsc"
 	},
 	"dependencies": {

packages/wrangler/src/__tests__/experimental-commands-api.test.ts

@@ -2,15 +2,67 @@ import { describe, expect, test } from "vitest";
 import { experimental_getWranglerCommands } from "../experimental-commands-api";
 
 describe("experimental_getWranglerCommands", () => {
+	test("returns global flags", () => {
+		const commandTree = experimental_getWranglerCommands().globalFlags;
+
+		expect(commandTree).toMatchInlineSnapshot(`
+			Object {
+			  "config": Object {
+			    "alias": "c",
+			    "describe": "Path to Wrangler configuration file",
+			    "requiresArg": true,
+			    "type": "string",
+			  },
+			  "cwd": Object {
+			    "describe": "Run as if Wrangler was started in the specified directory instead of the current working directory",
+			    "requiresArg": true,
+			    "type": "string",
+			  },
+			  "env": Object {
+			    "alias": "e",
+			    "describe": "Environment to use for operations, and for selecting .env and .dev.vars files",
+			    "requiresArg": true,
+			    "type": "string",
+			  },
+			  "env-file": Object {
+			    "array": true,
+			    "describe": "Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files",
+			    "requiresArg": true,
+			    "type": "string",
+			  },
+			  "experimental-provision": Object {
+			    "alias": Array [
+			      "x-provision",
+			    ],
+			    "describe": "Experimental: Enable automatic resource provisioning",
+			    "hidden": true,
+			    "type": "boolean",
+			  },
+			  "experimental-remote-bindings": Object {
+			    "alias": Array [
+			      "x-remote-bindings",
+			    ],
+			    "describe": "Experimental: Enable Remote Bindings",
+			    "hidden": true,
+			    "type": "boolean",
+			  },
+			  "v": Object {
+			    "alias": "version",
+			    "describe": "Show version number",
+			    "type": "boolean",
+			  },
+			}
+		`);
+	});
 	test("returns command tree structure", () => {
-		const commandTree = experimental_getWranglerCommands();
+		const commandTree = experimental_getWranglerCommands().registry;
 
 		expect(commandTree).toBeDefined();
 		expect(commandTree.subtree).toBeInstanceOf(Map);
 	});
 
 	test("includes expected commands with metadata", () => {
-		const commandTree = experimental_getWranglerCommands();
+		const commandTree = experimental_getWranglerCommands().registry;
 
 		expect(commandTree.subtree.has("docs")).toBe(true);
 		expect(commandTree.subtree.has("init")).toBe(true);
@@ -24,7 +76,7 @@ describe("experimental_getWranglerCommands", () => {
 	});
 
 	test("includes nested commands", () => {
-		const commandTree = experimental_getWranglerCommands();
+		const commandTree = experimental_getWranglerCommands().registry;
 
 		const d1Command = commandTree.subtree.get("d1");
 		expect(d1Command?.subtree).toBeInstanceOf(Map);
@@ -34,7 +86,7 @@ describe("experimental_getWranglerCommands", () => {
 	});
 
 	test("includes command arguments and metadata", () => {
-		const commandTree = experimental_getWranglerCommands();
+		const commandTree = experimental_getWranglerCommands().registry;
 
 		const initCommand = commandTree.subtree.get("init");
 		expect(initCommand?.definition?.type).toBe("command");
@@ -47,7 +99,7 @@ describe("experimental_getWranglerCommands", () => {
 	});
 
 	test("includes namespace commands", () => {
-		const commandTree = experimental_getWranglerCommands();
+		const commandTree = experimental_getWranglerCommands().registry;
 
 		const kvCommand = commandTree.subtree.get("kv");
 		expect(kvCommand?.definition?.type).toBe("namespace");
@@ -57,7 +109,7 @@ describe("experimental_getWranglerCommands", () => {
 	});
 
 	test("preserves command metadata properties", () => {
-		const commandTree = experimental_getWranglerCommands();
+		const commandTree = experimental_getWranglerCommands().registry;
 
 		const deployCommand = commandTree.subtree.get("deploy");
 		if (deployCommand?.definition?.type === "command") {

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

@@ -197,8 +197,6 @@ describe("metrics", () => {
 				argsCombination: "",
 				command: "wrangler docs",
 				args: {
-					xJsonConfig: true,
-					j: true,
 					search: ["<REDACTED>"],
 				},
 			};
@@ -455,12 +453,10 @@ describe("metrics", () => {
 				await expect(
 					runWrangler("docs arg -j=false")
 				).rejects.toThrowErrorMatchingInlineSnapshot(
-					`[Error: Wrangler now supports wrangler.json configuration files by default and ignores the value of the \`--experimental-json-config\` flag.]`
+					`[Error: Unknown argument: j]`
 				);
 				expect(requests.count).toBe(2);
-				expect(std.debug).toContain(
-					'"errorMessage":"Wrangler now supports wrangler.json configuration files by default and ignores the value of the `--experimental-json-config` flag."'
-				);
+				expect(std.debug).toContain('"errorMessage":"yargs validation error"');
 			});
 
 			it("should include an error message if the specific error has been allow-listed with a custom telemetry message", async () => {

packages/wrangler/src/experimental-commands-api.ts

@@ -5,9 +5,12 @@ import type { DefinitionTreeNode } from "./core/types";
  * EXPERIMENTAL: Get all registered Wrangler commands for documentation generation.
  * This API is experimental and may change without notice.
  *
- * @returns The complete command tree structure with all metadata
+ * @returns An object containing the command tree structure and global flags
  */
-export function experimental_getWranglerCommands(): DefinitionTreeNode {
-	const { registry } = createCLIParser([]);
-	return registry.getDefinitionTreeRoot();
+export function experimental_getWranglerCommands(): {
+	registry: DefinitionTreeNode;
+	globalFlags: ReturnType<typeof createCLIParser>["globalFlags"];
+} {
+	const { registry, globalFlags } = createCLIParser([]);
+	return { registry: registry.getDefinitionTreeRoot(), globalFlags };
 }

packages/wrangler/src/index.ts

@@ -338,6 +338,51 @@ if (proxy) {
 }
 
 export function createCLIParser(argv: string[]) {
+	const globalFlags = {
+		v: {
+			describe: "Show version number",
+			alias: "version",
+			type: "boolean",
+		},
+		cwd: {
+			describe:
+				"Run as if Wrangler was started in the specified directory instead of the current working directory",
+			type: "string",
+			requiresArg: true,
+		},
+		config: {
+			alias: "c",
+			describe: "Path to Wrangler configuration file",
+			type: "string",
+			requiresArg: true,
+		},
+		env: {
+			alias: "e",
+			describe:
+				"Environment to use for operations, and for selecting .env and .dev.vars files",
+			type: "string",
+			requiresArg: true,
+		},
+		"env-file": {
+			describe:
+				"Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files",
+			type: "string",
+			array: true,
+			requiresArg: true,
+		},
+		"experimental-remote-bindings": {
+			describe: `Experimental: Enable Remote Bindings`,
+			type: "boolean",
+			hidden: true,
+			alias: ["x-remote-bindings"],
+		},
+		"experimental-provision": {
+			describe: `Experimental: Enable automatic resource provisioning`,
+			type: "boolean",
+			hidden: true,
+			alias: ["x-provision"],
+		},
+	} as const;
 	// Type check result against CommonYargsOptions to make sure we've included
 	// all common options
 	const wrangler: CommonYargsArgv = makeCLI(argv)
@@ -362,29 +407,13 @@ export function createCLIParser(argv: string[]) {
 		// Define global options here, so they get included in the `Argv` type of
 		// the `wrangler` variable
 		.version(false)
-		.option("v", {
-			describe: "Show version number",
-			alias: "version",
-			type: "boolean",
-		})
-		.option("cwd", {
-			describe:
-				"Run as if Wrangler was started in the specified directory instead of the current working directory",
-			type: "string",
-			requiresArg: true,
-		})
+		.options(globalFlags)
 		.check(demandSingleValue("cwd"))
 		.middleware((_argv) => {
 			if (_argv.cwd) {
 				process.chdir(_argv.cwd);
 			}
 		})
-		.option("config", {
-			alias: "c",
-			describe: "Path to Wrangler configuration file",
-			type: "string",
-			requiresArg: true,
-		})
 		.check(
 			demandSingleValue(
 				"config",
@@ -394,38 +423,7 @@ export function createCLIParser(argv: string[]) {
 					(configArgv["_"][0] === "pages" && configArgv["_"][1] === "dev")
 			)
 		)
-		.option("env", {
-			alias: "e",
-			describe:
-				"Environment to use for operations, and for selecting .env and .dev.vars files",
-			type: "string",
-			requiresArg: true,
-		})
-		.option("env-file", {
-			describe:
-				"Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files",
-			type: "string",
-			array: true,
-			requiresArg: true,
-		})
 		.check(demandSingleValue("env"))
-		.option("experimental-json-config", {
-			alias: "j",
-			describe: `Support wrangler.json.`,
-			type: "boolean",
-			default: true,
-			deprecated: true,
-			hidden: true,
-		})
-		.check((args) => {
-			if (args["experimental-json-config"] === false) {
-				throw new CommandLineArgsError(
-					`Wrangler now supports wrangler.json configuration files by default and ignores the value of the \`--experimental-json-config\` flag.`,
-					{ telemetryMessage: true }
-				);
-			}
-			return true;
-		})
 		.check((args) => {
 			// Set process environment params from `.env` files if available.
 			const resolvedEnvFilePaths = (
@@ -447,18 +445,6 @@ export function createCLIParser(argv: string[]) {
 
 			return true;
 		})
-		.option("experimental-remote-bindings", {
-			describe: `Experimental: Enable Remote Bindings`,
-			type: "boolean",
-			hidden: true,
-			alias: ["x-remote-bindings"],
-		})
-		.option("experimental-provision", {
-			describe: `Experimental: Enable automatic resource provisioning`,
-			type: "boolean",
-			hidden: true,
-			alias: ["x-provision"],
-		})
 		.epilogue(
 			`Please report any issues to ${chalk.hex("#3B818D")(
 				"https://github.com/cloudflare/workers-sdk/issues/new/choose"
@@ -1477,7 +1463,7 @@ export function createCLIParser(argv: string[]) {
 
 	wrangler.exitProcess(false);
 
-	return { wrangler, registry };
+	return { wrangler, registry, globalFlags };
 }
 
 export async function main(argv: string[]): Promise<void> {