Add extra context to json flag description

cloudflare · Sep 9, 2024 · 7386e8f · 7386e8f
1 parent b7df331
commit 7386e8f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/packages/wrangler/src/__tests__/cloudchamber/curl.test.ts b/packages/wrangler/src/__tests__/cloudchamber/curl.test.ts
@@ -46,7 +46,7 @@ describe("cloudchamber curl", () => {
 			  -v, --version                   Show version number  [boolean]
 
 			OPTIONS
-			      --json                Return output as clean JSON  [boolean] [default: false]
+			      --json                Output json. Use for consistent, machine readable output.  [boolean] [default: false]
 			  -H, --header              Add headers in the form of --header <name>:<value>  [array]
 			  -D, --data                Add a JSON body to the request  [string]
 			  -X, --method  [string] [default: \\"GET\\"]

diff --git a/packages/wrangler/src/cloudchamber/curl.ts b/packages/wrangler/src/cloudchamber/curl.ts
@@ -7,12 +7,12 @@ import { ApiError } from "./client/core/ApiError";
 import { request } from "./client/core/request";
 import type { Config } from "../config";
 import type {
-	CommonYargsOptionsJSON,
-	StrictYargsOptionsToInterfaceJSON,
+	CommonYargsOptions,
+	StrictYargsOptionsToInterface,
 } from "../yargs-types";
 import type yargs from "yargs";
 
-export function yargsCurl(args: yargs.Argv<CommonYargsOptionsJSON>) {
+export function yargsCurl(args: yargs.Argv<CommonYargsOptions>) {
 	return args
 		.positional("path", { type: "string", default: "/" })
 		.option("header", {
@@ -44,11 +44,16 @@ export function yargsCurl(args: yargs.Argv<CommonYargsOptionsJSON>) {
 			describe: "Equivalent of using --data-binary @- in curl",
 			type: "boolean",
 			alias: "stdin",
+		})
+		.option("json", {
+			describe: "Output json. Use for consistent, machine readable output.",
+			type: "boolean",
+			default: false,
 		});
 }
 
 export async function curlCommand(
-	args: StrictYargsOptionsToInterfaceJSON<typeof yargsCurl>,
+	args: StrictYargsOptionsToInterface<typeof yargsCurl>,
 	config: Config
 ) {
 	await requestFromCmd(args, config);