wrangler 2.8.1 → 2.9.0

package/src/parse.ts

@@ -2,8 +2,12 @@ import * as fs from "node:fs";
 import { resolve } from "node:path";
 import TOML from "@iarna/toml";
 import { formatMessagesSync } from "esbuild";
+import {
+	parse as jsoncParse,
+	printParseErrorCode,
+	type ParseError as JsoncParseError,
+} from "jsonc-parser";
 import { logger } from "./logger";
-
 export type Message = {
 	text: string;
 	location?: Location;
@@ -139,6 +143,24 @@ export function parseJSON<T>(input: string, file?: string): T {
 	}
 }
 
+/**
+ * A wrapper around `JSONC.parse` that throws a `ParseError`.
+ */
+export function parseJSONC<T>(input: string, file?: string): T {
+	const errors: JsoncParseError[] = [];
+	const data = jsoncParse(input, errors);
+	if (errors.length) {
+		throw new ParseError({
+			text: printParseErrorCode(errors[0].error),
+			location: {
+				...indexLocation({ file, fileText: input }, errors[0].offset + 1),
+				length: errors[0].length,
+			},
+		});
+	}
+	return data;
+}
+
 /**
  * Reads a file into a node Buffer.
  */

package/src/publish/index.ts

@@ -13,14 +13,12 @@ import { getAssetPaths, getSiteAssetPaths } from "../sites";
 import { requireAuth } from "../user";
 import { collectKeyValues } from "../utils/collectKeyValues";
 import publish from "./publish";
-import type { ConfigPath } from "../index";
 import type {
-	CommonYargsOptions,
-	YargsOptionsToInterface,
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
 } from "../yargs-types";
-import type { Argv, ArgumentsCamelCase } from "yargs";
 
-export function publishOptions(yargs: Argv<CommonYargsOptions>) {
+export function publishOptions(yargs: CommonYargsArgv) {
 	return (
 		yargs
 			.positional("script", {
@@ -82,6 +80,13 @@ export function publishOptions(yargs: Argv<CommonYargsOptions>) {
 				deprecated: true,
 				hidden: true,
 			})
+			.option("public", {
+				describe: "Static assets to be served",
+				type: "string",
+				requiresArg: true,
+				deprecated: true,
+				hidden: true,
+			})
 			.option("assets", {
 				describe: "Static assets to be served",
 				type: "string",
@@ -179,14 +184,13 @@ export function publishOptions(yargs: Argv<CommonYargsOptions>) {
 	);
 }
 
-type PublishArgs = YargsOptionsToInterface<typeof publishOptions>;
-
-export async function publishHandler(args: ArgumentsCamelCase<PublishArgs>) {
+export async function publishHandler(
+	args: StrictYargsOptionsToInterface<typeof publishOptions>
+) {
 	await printWranglerBanner();
 
 	const configPath =
-		(args.config as ConfigPath) ||
-		(args.script && findWranglerToml(path.dirname(args.script)));
+		args.config || (args.script && findWranglerToml(path.dirname(args.script)));
 	const config = readConfig(configPath, args);
 	const entry = await getEntry(args, config, "publish");
 	await metrics.sendMetricsEvent(
@@ -202,7 +206,7 @@ export async function publishHandler(args: ArgumentsCamelCase<PublishArgs>) {
 	if (args.public) {
 		throw new Error("The --public field has been renamed to --assets");
 	}
-	if (args["experimental-public"]) {
+	if (args.experimentalPublic) {
 		throw new Error(
 			"The --experimental-public field has been renamed to --assets"
 		);
@@ -247,13 +251,13 @@ export async function publishHandler(args: ArgumentsCamelCase<PublishArgs>) {
 		env: args.env,
 		compatibilityDate: args.latest
 			? new Date().toISOString().substring(0, 10)
-			: args["compatibility-date"],
-		compatibilityFlags: args["compatibility-flags"],
+			: args.compatibilityDate,
+		compatibilityFlags: args.compatibilityFlags,
 		vars: cliVars,
 		defines: cliDefines,
 		triggers: args.triggers,
-		jsxFactory: args["jsx-factory"],
-		jsxFragment: args["jsx-fragment"],
+		jsxFactory: args.jsxFactory,
+		jsxFragment: args.jsxFragment,
 		tsconfig: args.tsconfig,
 		routes: args.routes,
 		assetPaths,

package/src/publish/publish.ts

@@ -609,9 +609,9 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 
 		printBindings({ ...withoutStaticAssets, vars: maskedVars });
 
-		await ensureQueuesExist(config);
-
 		if (!props.dryRun) {
+			await ensureQueuesExist(config);
+
 			// Upload the script so it has time to propagate.
 			// We can also now tell whether available_on_subdomain is set
 			try {

package/src/pubsub/pubsub-commands.ts

@@ -1,4 +1,3 @@
-import { type ConfigPath } from "..";
 import { readConfig } from "../config";
 import { confirm } from "../dialogs";
 import { CommandLineArgsError } from "../index";
@@ -7,13 +6,13 @@ import * as metrics from "../metrics";
 import { parseHumanDuration } from "../parse";
 import { requireAuth } from "../user";
 import * as pubsub from ".";
-import type { CommonYargsOptions } from "../yargs-types";
-import type { Argv, CommandModule } from "yargs";
+import type { CommonYargsArgv, CommonYargsOptions } from "../yargs-types";
+import type { CommandModule } from "yargs";
 
 export function pubSubCommands(
-	pubsubYargs: Argv<CommonYargsOptions>,
+	pubsubYargs: CommonYargsArgv,
 	subHelp: CommandModule<CommonYargsOptions, CommonYargsOptions>
-): Argv {
+) {
 	return pubsubYargs
 		.command(subHelp)
 		.command(
@@ -39,7 +38,7 @@ export function pubSubCommands(
 								.epilogue(pubsub.pubSubBetaWarning);
 						},
 						async (args) => {
-							const config = readConfig(args.config as ConfigPath, args);
+							const config = readConfig(args.config, args);
 							const accountId = await requireAuth(config);
 
 							const namespace: pubsub.PubSubNamespace = {
@@ -64,7 +63,7 @@ export function pubSubCommands(
 							return yargs.epilogue(pubsub.pubSubBetaWarning);
 						},
 						async (args) => {
-							const config = readConfig(args.config as ConfigPath, args);
+							const config = readConfig(args.config, args);
 							const accountId = await requireAuth(config);
 
 							logger.log(await pubsub.listPubSubNamespaces(accountId));
@@ -86,7 +85,7 @@ export function pubSubCommands(
 								.epilogue(pubsub.pubSubBetaWarning);
 						},
 						async (args) => {
-							const config = readConfig(args.config as ConfigPath, args);
+							const config = readConfig(args.config, args);
 							const accountId = await requireAuth(config);
 
 							if (
@@ -116,7 +115,7 @@ export function pubSubCommands(
 								.epilogue(pubsub.pubSubBetaWarning);
 						},
 						async (args) => {
-							const config = readConfig(args.config as ConfigPath, args);
+							const config = readConfig(args.config, args);
 							const accountId = await requireAuth(config);
 
 							logger.log(
@@ -165,7 +164,7 @@ export function pubSubCommands(
 						})
 						.epilogue(pubsub.pubSubBetaWarning),
 				async (args) => {
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 					const accountId = await requireAuth(config);
 
 					const broker: pubsub.PubSubBroker = {
@@ -230,7 +229,7 @@ export function pubSubCommands(
 						})
 						.epilogue(pubsub.pubSubBetaWarning),
 				async (args) => {
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 					const accountId = await requireAuth(config);
 
 					const broker: pubsub.PubSubBrokerUpdate = {};
@@ -284,7 +283,7 @@ export function pubSubCommands(
 						.epilogue(pubsub.pubSubBetaWarning);
 				},
 				async (args) => {
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 					const accountId = await requireAuth(config);
 
 					logger.log(await pubsub.listPubSubBrokers(accountId, args.namespace));
@@ -314,7 +313,7 @@ export function pubSubCommands(
 							.epilogue(pubsub.pubSubBetaWarning);
 					},
 					async (args) => {
-						const config = readConfig(args.config as ConfigPath, args);
+						const config = readConfig(args.config, args);
 						const accountId = await requireAuth(config);
 
 						if (
@@ -354,7 +353,7 @@ export function pubSubCommands(
 							.epilogue(pubsub.pubSubBetaWarning);
 					},
 					async (args) => {
-						const config = readConfig(args.config as ConfigPath, args);
+						const config = readConfig(args.config, args);
 						const accountId = await requireAuth(config);
 
 						logger.log(
@@ -413,7 +412,7 @@ export function pubSubCommands(
 						.epilogue(pubsub.pubSubBetaWarning);
 				},
 				async (args) => {
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 					const accountId = await requireAuth(config);
 
 					let parsedExpiration: number | undefined;
@@ -473,7 +472,7 @@ export function pubSubCommands(
 						.epilogue(pubsub.pubSubBetaWarning);
 				},
 				async (args) => {
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 					const accountId = await requireAuth(config);
 
 					const numTokens = args.jti.length;
@@ -521,7 +520,7 @@ export function pubSubCommands(
 						.epilogue(pubsub.pubSubBetaWarning);
 				},
 				async (args) => {
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 					const accountId = await requireAuth(config);
 
 					const numTokens = args.jti.length;
@@ -562,7 +561,7 @@ export function pubSubCommands(
 						.epilogue(pubsub.pubSubBetaWarning);
 				},
 				async (args) => {
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 					const accountId = await requireAuth(config);
 
 					logger.log(`Listing previously revoked tokens for ${args.name}...`);
@@ -601,7 +600,7 @@ export function pubSubCommands(
 						.epilogue(pubsub.pubSubBetaWarning);
 				},
 				async (args) => {
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 					const accountId = await requireAuth(config);
 
 					logger.log(

package/src/queues/cli/commands/consumer/add.ts

@@ -1,21 +1,13 @@
-import { type Argv } from "yargs";
 import { readConfig } from "../../../../config";
 import { logger } from "../../../../logger";
 import { postConsumer } from "../../../client";
-import type { CommonYargsOptions } from "../../../../yargs-types";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../../yargs-types";
 import type { PostConsumerBody } from "../../../client";
 
-type Args = CommonYargsOptions & {
-	config?: string;
-	["queue-name"]: string;
-	["script-name"]: string;
-	["batch-size"]?: number;
-	["batch-timeout"]?: number;
-	["message-retries"]?: number;
-	["dead-letter-queue"]?: string;
-};
-
-export function options(yargs: Argv<CommonYargsOptions>): Argv<Args> {
+export function options(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("queue-name", {
 			type: "string",
@@ -48,24 +40,26 @@ export function options(yargs: Argv<CommonYargsOptions>): Argv<Args> {
 		});
 }
 
-export async function handler(args: Args) {
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
 	const config = readConfig(args.config, args);
 
 	const body: PostConsumerBody = {
-		script_name: args["script-name"],
+		script_name: args.scriptName,
 		// TODO(soon) is this still the correct usage of the environment?
-		environment_name: args.env || "", // API expects empty string as default
+		environment_name: args.env ?? "", // API expects empty string as default
 		settings: {
-			batch_size: args["batch-size"],
-			max_retries: args["message-retries"],
-			max_wait_time_ms: args["batch-timeout"] // API expects milliseconds
-				? 1000 * args["batch-timeout"]
+			batch_size: args.batchSize,
+			max_retries: args.messageRetries,
+			max_wait_time_ms: args.batchTimeout // API expects milliseconds
+				? 1000 * args.batchTimeout
 				: undefined,
 		},
-		dead_letter_queue: args["dead-letter-queue"],
+		dead_letter_queue: args.deadLetterQueue,
 	};
 
-	logger.log(`Adding consumer to queue ${args["queue-name"]}.`);
-	await postConsumer(config, args["queue-name"], body);
-	logger.log(`Added consumer to queue ${args["queue-name"]}.`);
+	logger.log(`Adding consumer to queue ${args.queueName}.`);
+	await postConsumer(config, args.queueName, body);
+	logger.log(`Added consumer to queue ${args.queueName}.`);
 }

package/src/queues/cli/commands/consumer/index.ts

@@ -1,11 +1,8 @@
-import { type BuilderCallback } from "yargs";
-import { type CommonYargsOptions } from "../../../../yargs-types";
 import { options as addOptions, handler as addHandler } from "./add";
 import { options as removeOptions, handler as removeHandler } from "./remove";
+import type { CommonYargsArgv } from "../../../../yargs-types";
 
-export const consumers: BuilderCallback<CommonYargsOptions, unknown> = (
-	yargs
-) => {
+export function consumers(yargs: CommonYargsArgv) {
 	yargs.command(
 		"add <queue-name> <script-name>",
 		"Add a Queue Consumer",
@@ -19,4 +16,4 @@ export const consumers: BuilderCallback<CommonYargsOptions, unknown> = (
 		removeOptions,
 		removeHandler
 	);
-};
+}

package/src/queues/cli/commands/consumer/remove.ts

@@ -1,16 +1,12 @@
-import { type Argv } from "yargs";
 import { readConfig } from "../../../../config";
 import { logger } from "../../../../logger";
 import { deleteConsumer } from "../../../client";
-import type { CommonYargsOptions } from "../../../../yargs-types";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../../yargs-types";
 
-type Args = CommonYargsOptions & {
-	config?: string;
-	["queue-name"]: string;
-	["script-name"]: string;
-};
-
-export function options(yargs: Argv<CommonYargsOptions>): Argv<Args> {
+export function options(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("queue-name", {
 			type: "string",
@@ -24,15 +20,12 @@ export function options(yargs: Argv<CommonYargsOptions>): Argv<Args> {
 		});
 }
 
-export async function handler(args: Args) {
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
 	const config = readConfig(args.config, args);
 
-	logger.log(`Removing consumer from queue ${args["queue-name"]}.`);
-	await deleteConsumer(
-		config,
-		args["queue-name"],
-		args["script-name"],
-		args.env
-	);
-	logger.log(`Removed consumer from queue ${args["queue-name"]}.`);
+	logger.log(`Removing consumer from queue ${args.queueName}.`);
+	await deleteConsumer(config, args.queueName, args.scriptName, args.env);
+	logger.log(`Removed consumer from queue ${args.queueName}.`);
 }

package/src/queues/cli/commands/create.ts

@@ -1,14 +1,12 @@
-import { type Argv } from "yargs";
 import { readConfig } from "../../../config";
 import { logger } from "../../../logger";
 import { createQueue } from "../../client";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../yargs-types";
 
-interface Args {
-	config?: string;
-	name: string;
-}
-
-export function options(yargs: Argv): Argv<Args> {
+export function options(yargs: CommonYargsArgv) {
 	return yargs.positional("name", {
 		type: "string",
 		demandOption: true,
@@ -16,7 +14,9 @@ export function options(yargs: Argv): Argv<Args> {
 	});
 }
 
-export async function handler(args: Args) {
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
 	const config = readConfig(args.config, args);
 
 	logger.log(`Creating queue ${args.name}.`);

package/src/queues/cli/commands/delete.ts

@@ -1,14 +1,12 @@
-import { type Argv } from "yargs";
 import { readConfig } from "../../../config";
 import { logger } from "../../../logger";
 import { deleteQueue } from "../../client";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../yargs-types";
 
-interface Args {
-	config?: string;
-	name: string;
-}
-
-export function options(yargs: Argv): Argv<Args> {
+export function options(yargs: CommonYargsArgv) {
 	// TODO(soon) --force option
 	return yargs.positional("name", {
 		type: "string",
@@ -17,7 +15,9 @@ export function options(yargs: Argv): Argv<Args> {
 	});
 }
 
-export async function handler(args: Args) {
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
 	const config = readConfig(args.config, args);
 
 	logger.log(`Deleting queue ${args.name}.`);

package/src/queues/cli/commands/index.ts

@@ -1,13 +1,12 @@
-import { type BuilderCallback } from "yargs";
-import { type CommonYargsOptions } from "../../../yargs-types";
 import { HandleUnauthorizedError } from "../../utils";
 import { consumers } from "./consumer";
 
 import { options as createOptions, handler as createHandler } from "./create";
 import { options as deleteOptions, handler as deleteHandler } from "./delete";
 import { options as listOptions, handler as listHandler } from "./list";
+import type { CommonYargsArgv } from "../../../yargs-types";
 
-export const queues: BuilderCallback<CommonYargsOptions, unknown> = (yargs) => {
+export function queues(yargs: CommonYargsArgv) {
 	yargs.command("list", "List Queues", listOptions, listHandler);
 
 	yargs.command(
@@ -33,4 +32,4 @@ export const queues: BuilderCallback<CommonYargsOptions, unknown> = (yargs) => {
 	);
 
 	yargs.fail(HandleUnauthorizedError);
-};
+}

package/src/queues/cli/commands/list.ts

@@ -1,14 +1,12 @@
-import { type Argv } from "yargs";
 import { readConfig } from "../../../config";
 import { logger } from "../../../logger";
 import { listQueues } from "../../client";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../../../yargs-types";
 
-interface Args {
-	config?: string;
-	page?: number;
-}
-
-export function options(yargs: Argv): Argv<Args> {
+export function options(yargs: CommonYargsArgv) {
 	return yargs.options({
 		page: {
 			type: "number",
@@ -17,7 +15,9 @@ export function options(yargs: Argv): Argv<Args> {
 	});
 }
 
-export async function handler(args: Args) {
+export async function handler(
+	args: StrictYargsOptionsToInterface<typeof options>
+) {
 	const config = readConfig(args.config, args);
 
 	const queues = await listQueues(config, args.page);

package/src/r2/index.ts

@@ -19,22 +19,23 @@ import {
 	putR2Object,
 } from "./helpers";
 
-import type { ConfigPath } from "../index";
+import type { CommonYargsArgv } from "../yargs-types";
 import type { Readable } from "node:stream";
-import type { BuilderCallback } from "yargs";
 
-export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
+export function r2(r2Yargs: CommonYargsArgv) {
 	return r2Yargs
 		.command("object", "Manage R2 objects", (r2ObjectYargs) => {
 			return r2ObjectYargs
 				.command(
 					"get <objectPath>",
 					"Fetch an object from an R2 bucket",
-					(Objectyargs) => {
-						return Objectyargs.positional("objectPath", {
-							describe: "The source object path in the form of {bucket}/{key}",
-							type: "string",
-						})
+					(objectArgs) => {
+						return objectArgs
+							.positional("objectPath", {
+								describe:
+									"The source object path in the form of {bucket}/{key}",
+								type: "string",
+							})
 							.option("file", {
 								describe: "The destination file to create",
 								alias: "f",
@@ -51,10 +52,7 @@ export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
 							});
 					},
 					async (objectGetYargs) => {
-						const config = readConfig(
-							objectGetYargs.config as ConfigPath,
-							objectGetYargs
-						);
+						const config = readConfig(objectGetYargs.config, objectGetYargs);
 						const accountId = await requireAuth(config);
 						const { objectPath, pipe } = objectGetYargs;
 						const { bucket, key } = bucketAndKeyFromObjectPath(objectPath);
@@ -144,10 +142,7 @@ export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
 					async (objectPutYargs) => {
 						await printWranglerBanner();
 
-						const config = readConfig(
-							objectPutYargs.config as ConfigPath,
-							objectPutYargs
-						);
+						const config = readConfig(objectPutYargs.config, objectPutYargs);
 						const accountId = await requireAuth(config);
 						const { objectPath, file, pipe, ...options } = objectPutYargs;
 						const { bucket, key } = bucketAndKeyFromObjectPath(objectPath);
@@ -210,7 +205,7 @@ export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
 						const { objectPath } = args;
 						await printWranglerBanner();
 
-						const config = readConfig(args.config as ConfigPath, args);
+						const config = readConfig(args.config, args);
 						const accountId = await requireAuth(config);
 						const { bucket, key } = bucketAndKeyFromObjectPath(objectPath);
 						logger.log(`Deleting object "${key}" from bucket "${bucket}".`);
@@ -235,7 +230,7 @@ export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
 				async (args) => {
 					await printWranglerBanner();
 
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 
 					const accountId = await requireAuth(config);
 
@@ -248,16 +243,21 @@ export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
 				}
 			);
 
-			r2BucketYargs.command("list", "List R2 buckets", {}, async (args) => {
-				const config = readConfig(args.config as ConfigPath, args);
+			r2BucketYargs.command(
+				"list",
+				"List R2 buckets",
+				(listArgs) => listArgs,
+				async (args) => {
+					const config = readConfig(args.config, args);
 
-				const accountId = await requireAuth(config);
+					const accountId = await requireAuth(config);
 
-				logger.log(JSON.stringify(await listR2Buckets(accountId), null, 2));
-				await metrics.sendMetricsEvent("list r2 buckets", {
-					sendMetrics: config.send_metrics,
-				});
-			});
+					logger.log(JSON.stringify(await listR2Buckets(accountId), null, 2));
+					await metrics.sendMetricsEvent("list r2 buckets", {
+						sendMetrics: config.send_metrics,
+					});
+				}
+			);
 
 			r2BucketYargs.command(
 				"delete <name>",
@@ -272,7 +272,7 @@ export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
 				async (args) => {
 					await printWranglerBanner();
 
-					const config = readConfig(args.config as ConfigPath, args);
+					const config = readConfig(args.config, args);
 
 					const accountId = await requireAuth(config);
 
@@ -286,4 +286,4 @@ export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
 			);
 			return r2BucketYargs;
 		});
-};
+}