wrangler 2.8.1 → 2.9.0

package/src/dev.tsx

@@ -19,7 +19,6 @@ import { collectKeyValues } from "./utils/collectKeyValues";
 import { identifyD1BindingsAsBeta } from "./worker";
 import { getHostFromRoute, getZoneForRoute, getZoneIdFromHost } from "./zones";
 import {
-	type ConfigPath,
 	DEFAULT_INSPECTOR_PORT,
 	DEFAULT_LOCAL_PORT,
 	getDevCompatibilityDate,
@@ -30,59 +29,15 @@ import {
 } from "./index";
 import type { Config, Environment } from "./config";
 import type { Route } from "./config/environment";
+import type { LoggerLevel } from "./logger";
 import type { EnablePagesAssetsServiceBindingOptions } from "./miniflare-cli/types";
 import type { CfWorkerInit } from "./worker";
-import type { CommonYargsOptions } from "./yargs-types";
-import type { Argv, ArgumentsCamelCase } from "yargs";
-
-interface DevArgs {
-	config?: string;
-	script?: string;
-	name?: string;
-	bundle?: boolean;
-	build?: boolean;
-	format?: string;
-	env?: string;
-	"compatibility-date"?: string;
-	"compatibility-flags"?: string[];
-	latest?: boolean;
-	ip?: string;
-	inspect?: boolean;
-	port?: number;
-	"inspector-port"?: number;
-	routes?: string[];
-	host?: string;
-	"local-protocol"?: "http" | "https";
-	"local-upstream"?: string | undefined;
-	"experimental-public"?: string;
-	public?: string;
-	assets?: string;
-	site?: string;
-	"site-include"?: string[];
-	"site-exclude"?: string[];
-	"upstream-protocol"?: "http" | "https";
-	"jsx-factory"?: string;
-	"jsx-fragment"?: string;
-	tsconfig?: string;
-	local?: boolean;
-	"experimental-local"?: boolean;
-	"experimental-local-remote-kv"?: boolean;
-	minify?: boolean;
-	var?: string[];
-	define?: string[];
-	"node-compat"?: boolean;
-	"experimental-enable-local-persistence"?: boolean;
-	persist?: boolean;
-	"persist-to"?: string;
-	"live-reload"?: boolean;
-	onReady?: (ip: string, port: number) => void;
-	logLevel?: "none" | "info" | "error" | "log" | "warn" | "debug";
-	logPrefix?: string;
-	showInteractiveDevSession?: boolean;
-	"test-scheduled"?: boolean;
-}
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "./yargs-types";
 
-export function devOptions(yargs: Argv<CommonYargsOptions>): Argv<DevArgs> {
+export function devOptions(yargs: CommonYargsArgv) {
 	return (
 		yargs
 			.positional("script", {
@@ -177,6 +132,13 @@ export function devOptions(yargs: Argv<CommonYargsOptions>): Argv<DevArgs> {
 				type: "string",
 				requiresArg: true,
 			})
+			.option("public", {
+				describe: "(Deprecated) Static assets to be served",
+				type: "string",
+				requiresArg: true,
+				deprecated: true,
+				hidden: true,
+			})
 			.option("site", {
 				describe: "Root folder of static assets for Workers Sites",
 				type: "string",
@@ -322,12 +284,15 @@ export function devOptions(yargs: Argv<CommonYargsOptions>): Argv<DevArgs> {
 			.option("log-level", {
 				choices: ["debug", "info", "log", "warn", "error", "none"] as const,
 				describe: "Specify logging level",
-				default: "log",
+				// Yargs requires this to type log-level properly
+				default: "log" as LoggerLevel,
 			})
 	);
 }
 
-export async function devHandler(args: ArgumentsCamelCase<DevArgs>) {
+type DevArguments = StrictYargsOptionsToInterface<typeof devOptions>;
+
+export async function devHandler(args: DevArguments) {
 	if (!(args.local || args.experimentalLocal)) {
 		const isLoggedIn = await loginOrRefreshIfRequired();
 		if (!isLoggedIn) {
@@ -371,13 +336,16 @@ export type AdditionalDevProps = {
 	d1Databases?: Environment["d1_databases"];
 };
 
-type StartDevOptions = ArgumentsCamelCase<DevArgs> &
+type StartDevOptions = DevArguments &
 	// These options can be passed in directly when called with the `wrangler.dev()` API.
 	// They aren't exposed as CLI arguments.
 	AdditionalDevProps & {
 		forceLocal?: boolean;
 		disableDevRegistry?: boolean;
 		enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
+		onReady?: (ip: string, port: number) => void;
+		logPrefix?: string;
+		showInteractiveDevSession?: boolean;
 	};
 
 export async function startDev(args: StartDevOptions) {
@@ -400,9 +368,8 @@ export async function startDev(args: StartDevOptions) {
 		}
 
 		const configPath =
-			(args.config as ConfigPath) ||
-			((args.script &&
-				findWranglerToml(path.dirname(args.script))) as ConfigPath);
+			args.config ||
+			(args.script && findWranglerToml(path.dirname(args.script)));
 		let config = readConfig(configPath, args);
 
 		if (config.configPath) {
@@ -466,12 +433,12 @@ export async function startDev(args: StartDevOptions) {
 					initialMode={
 						args.local || args.experimentalLocal ? "local" : "remote"
 					}
-					jsxFactory={args["jsx-factory"] || configParam.jsx_factory}
-					jsxFragment={args["jsx-fragment"] || configParam.jsx_fragment}
+					jsxFactory={args.jsxFactory || configParam.jsx_factory}
+					jsxFragment={args.jsxFragment || configParam.jsx_fragment}
 					tsconfig={args.tsconfig ?? configParam.tsconfig}
 					upstreamProtocol={upstreamProtocol}
 					localProtocol={args.localProtocol || configParam.dev.local_protocol}
-					localUpstream={args["local-upstream"] || host}
+					localUpstream={args.localUpstream ?? host}
 					localPersistencePath={localPersistencePath}
 					liveReload={args.liveReload || false}
 					accountId={configParam.account_id || getAccountFromCache()?.id}
@@ -506,7 +473,7 @@ export async function startDev(args: StartDevOptions) {
 					enablePagesAssetsServiceBinding={args.enablePagesAssetsServiceBinding}
 					firstPartyWorker={configParam.first_party_worker}
 					sendMetrics={configParam.send_metrics}
-					testScheduled={args["test-scheduled"]}
+					testScheduled={args.testScheduled}
 					experimentalLocal={args.experimentalLocal}
 					experimentalLocalRemoteKv={args.experimentalLocalRemoteKv}
 				/>
@@ -551,9 +518,7 @@ export async function startApiDev(args: StartDevOptions) {
 	await printWranglerBanner();
 
 	const configPath =
-		(args.config as ConfigPath) ||
-		((args.script &&
-			findWranglerToml(path.dirname(args.script))) as ConfigPath);
+		args.config || (args.script && findWranglerToml(path.dirname(args.script)));
 	const config = readConfig(configPath, args);
 
 	const {
@@ -601,34 +566,32 @@ export async function startApiDev(args: StartDevOptions) {
 			build: configParam.build || {},
 			define: { ...config.define, ...cliDefines },
 			initialMode: args.local ? "local" : "remote",
-			jsxFactory: args["jsx-factory"] || configParam.jsx_factory,
-			jsxFragment: args["jsx-fragment"] || configParam.jsx_fragment,
+			jsxFactory: args.jsxFactory ?? configParam.jsx_factory,
+			jsxFragment: args.jsxFragment ?? configParam.jsx_fragment,
 			tsconfig: args.tsconfig ?? configParam.tsconfig,
 			upstreamProtocol: upstreamProtocol,
-			localProtocol: args.localProtocol || configParam.dev.local_protocol,
-			localUpstream: args["local-upstream"] || host,
+			localProtocol: args.localProtocol ?? configParam.dev.local_protocol,
+			localUpstream: args.localUpstream ?? host,
 			localPersistencePath,
-			liveReload: args.liveReload || false,
-			accountId: configParam.account_id || getAccountFromCache()?.id,
+			liveReload: args.liveReload ?? false,
+			accountId: configParam.account_id ?? getAccountFromCache()?.id,
 			assetPaths: assetPaths,
 			assetsConfig: configParam.assets,
 			//port can be 0, which means to use a random port
 			initialPort: args.port ?? configParam.dev.port ?? (await getLocalPort()),
-			initialIp: args.ip || configParam.dev.ip,
+			initialIp: args.ip ?? configParam.dev.ip,
 			inspectorPort:
-				args["inspector-port"] ??
+				args.inspectorPort ??
 				configParam.dev.inspector_port ??
 				(await getInspectorPort()),
 			isWorkersSite: Boolean(args.site || configParam.site),
 			compatibilityDate: getDevCompatibilityDate(
 				config,
 				// Only `compatibilityDate` will be set when using `unstable_dev`
-				args["compatibility-date"] ?? args.compatibilityDate
+				args.compatibilityDate
 			),
 			compatibilityFlags:
-				args["compatibility-flags"] ??
-				args.compatibilityFlags ??
-				configParam.compatibility_flags,
+				args.compatibilityFlags ?? configParam.compatibility_flags,
 			usageModel: configParam.usage_model,
 			bindings: bindings,
 			crons: configParam.triggers.crons,
@@ -751,8 +714,7 @@ async function validateDevServerSettings(
 			"Passing --inspect is unnecessary, now you can always connect to devtools."
 		);
 	}
-
-	if (args["experimental-public"]) {
+	if (args.experimentalPublic) {
 		throw new Error(
 			"The --experimental-public field has been renamed to --assets"
 		);
@@ -762,7 +724,7 @@ async function validateDevServerSettings(
 		throw new Error("The --public field has been renamed to --assets");
 	}
 
-	if ((args.assets || config.assets) && (args.site || config.site)) {
+	if ((args.assets ?? config.assets) && (args.site ?? config.site)) {
 		throw new Error("Cannot use Assets and Workers Sites in the same Worker.");
 	}
 
@@ -772,7 +734,7 @@ async function validateDevServerSettings(
 		);
 	}
 	const upstreamProtocol =
-		args["upstream-protocol"] || config.dev.upstream_protocol;
+		args.upstreamProtocol ?? config.dev.upstream_protocol;
 	if (upstreamProtocol === "http") {
 		logger.warn(
 			"Setting upstream-protocol to http is not currently implemented.\n" +

package/src/dispatch-namespace.ts

@@ -4,9 +4,8 @@ import { logger } from "./logger";
 import * as metrics from "./metrics";
 import { requireAuth } from "./user";
 import { printWranglerBanner } from ".";
-import type { ConfigPath } 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";
 
 type Namespace = {
 	namespace_id: string;
@@ -106,19 +105,24 @@ async function renameWorkerNamespace(
 }
 
 export function workerNamespaceCommands(
-	workerNamespaceYargs: Argv<CommonYargsOptions>,
+	workerNamespaceYargs: CommonYargsArgv,
 	subHelp: CommandModule<CommonYargsOptions, CommonYargsOptions>
 ) {
 	return workerNamespaceYargs
 		.command(subHelp)
-		.command("list", "List all dispatch namespaces", {}, async (args) => {
-			const config = readConfig(args.config as ConfigPath, args);
-			const accountId = await requireAuth(config);
-			await listWorkerNamespaces(accountId);
-			await metrics.sendMetricsEvent("list dispatch namespaces", {
-				sendMetrics: config.send_metrics,
-			});
-		})
+		.command(
+			"list",
+			"List all dispatch namespaces",
+			(args) => args,
+			async (args) => {
+				const config = readConfig(args.config, args);
+				const accountId = await requireAuth(config);
+				await listWorkerNamespaces(accountId);
+				await metrics.sendMetricsEvent("list dispatch namespaces", {
+					sendMetrics: config.send_metrics,
+				});
+			}
+		)
 		.command(
 			"get <name>",
 			"Get information about a dispatch namespace",
@@ -130,7 +134,7 @@ export function workerNamespaceCommands(
 				});
 			},
 			async (args) => {
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const accountId = await requireAuth(config);
 				await getWorkerNamespaceInfo(accountId, args.name);
 				await metrics.sendMetricsEvent("view dispatch namespace", {
@@ -150,7 +154,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const accountId = await requireAuth(config);
 				await createWorkerNamespace(accountId, args.name);
 				await metrics.sendMetricsEvent("create dispatch namespace", {
@@ -170,7 +174,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const accountId = await requireAuth(config);
 				await deleteWorkerNamespace(accountId, args.name);
 				await metrics.sendMetricsEvent("delete dispatch namespace", {
@@ -196,7 +200,7 @@ export function workerNamespaceCommands(
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const accountId = await requireAuth(config);
 				await renameWorkerNamespace(accountId, args.oldName, args.newName);
 				await metrics.sendMetricsEvent("rename dispatch namespace", {

package/src/docs/index.ts

@@ -5,10 +5,9 @@ import * as metrics from "../metrics";
 import openInBrowser from "../open-in-browser";
 
 import type {
-	CommonYargsOptions,
-	YargsOptionsToInterface,
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
 } from "../yargs-types";
-import type { ArgumentsCamelCase, Argv } from "yargs";
 
 const argToUrlHash = {
 	d1: "d1",
@@ -34,7 +33,7 @@ const argToUrlHash = {
 	deployments: "deployments",
 };
 
-export function docsOptions(yargs: Argv<CommonYargsOptions>) {
+export function docsOptions(yargs: CommonYargsArgv) {
 	return yargs.positional("command", {
 		describe: "Enter the wrangler command you want to know more about",
 		type: "string",
@@ -69,13 +68,13 @@ export function docsOptions(yargs: Argv<CommonYargsOptions>) {
 	});
 }
 
-type DocsArgs = YargsOptionsToInterface<typeof docsOptions>;
-
 function isValidParam(k: string): k is keyof typeof argToUrlHash {
 	return k in argToUrlHash;
 }
 
-export async function docsHandler(args: ArgumentsCamelCase<DocsArgs>) {
+export async function docsHandler(
+	args: StrictYargsOptionsToInterface<typeof docsOptions>
+) {
 	let urlToOpen =
 		"https://developers.cloudflare.com/workers/wrangler/commands/";
 
@@ -91,7 +90,7 @@ export async function docsHandler(args: ArgumentsCamelCase<DocsArgs>) {
 
 	logger.log(`Opening a link in your default browser: ${urlToOpen}`);
 	await openInBrowser(urlToOpen);
-	const config = readConfig(undefined, {});
+	const config = readConfig(undefined, args);
 	await metrics.sendMetricsEvent("view docs", {
 		sendMetrics: config.send_metrics,
 	});

package/src/generate/index.ts

@@ -5,12 +5,11 @@ import { CommandLineArgsError, printWranglerBanner } from "../index";
 import { initHandler } from "../init";
 import { logger } from "../logger";
 import type {
-	CommonYargsOptions,
-	YargsOptionsToInterface,
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
 } from "../yargs-types";
-import type { Argv } from "yargs";
 
-export function generateOptions(yargs: Argv<CommonYargsOptions>) {
+export function generateOptions(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("name", {
 			describe: "Name of the Workers project",
@@ -34,7 +33,7 @@ export function generateOptions(yargs: Argv<CommonYargsOptions>) {
 			deprecated: true,
 		});
 }
-type GenerateArgs = YargsOptionsToInterface<typeof generateOptions>;
+type GenerateArgs = StrictYargsOptionsToInterface<typeof generateOptions>;
 
 // Originally, generate was a rust function: https://github.com/cloudflare/wrangler/blob/master/src/cli/mod.rs#L106-L123
 export async function generateHandler(args: GenerateArgs) {
@@ -44,17 +43,16 @@ export async function generateHandler(args: GenerateArgs) {
 	if (args.template === undefined) {
 		return initHandler({
 			name: args.name,
-			template: undefined,
 			site: undefined,
 			yes: undefined,
 			fromDash: undefined,
-			"from-dash": undefined,
 			v: undefined,
 			config: undefined,
 			env: undefined,
 			type: undefined,
 			_: args._,
 			$0: args.$0,
+			experimentalJsonConfig: false,
 		});
 	}
 

package/src/index.ts

@@ -50,12 +50,9 @@ import {
 import { whoami } from "./whoami";
 
 import type { Config } from "./config";
-import type { CommonYargsOptions } from "./yargs-types";
-import type { ArgumentsCamelCase } from "yargs";
+import type { CommonYargsArgv, CommonYargsOptions } from "./yargs-types";
 import type Yargs from "yargs";
 
-export type ConfigPath = string | undefined;
-
 const resetColor = "\x1b[0m";
 const fgGreenColor = "\x1b[32m";
 export const DEFAULT_LOCAL_PORT = 8787;
@@ -176,7 +173,7 @@ export class CommandLineArgsError extends Error {}
 export function createCLIParser(argv: string[]) {
 	// Type check result against CommonYargsOptions to make sure we've included
 	// all common options
-	const wrangler: Yargs.Argv<CommonYargsOptions> = makeCLI(argv)
+	const wrangler: CommonYargsArgv = makeCLI(argv)
 		.strict()
 		// We handle errors ourselves in a try-catch around `yargs.parse`.
 		// If you want the "help info" to be displayed then throw an instance of `CommandLineArgsError`.
@@ -212,6 +209,11 @@ export function createCLIParser(argv: string[]) {
 			type: "string",
 			requiresArg: true,
 		})
+		.option("experimental-json-config", {
+			alias: "j",
+			describe: `Experimental: Support wrangler.json`,
+			type: "boolean",
+		})
 		.check((args) => {
 			// Grab locally specified env params from `.env` file
 			const loaded = loadDotEnv(".env", args.env);
@@ -221,7 +223,10 @@ export function createCLIParser(argv: string[]) {
 			return true;
 		});
 
-	wrangler.group(["config", "env", "help", "version"], "Flags:");
+	wrangler.group(
+		["experimental-json-config", "config", "env", "help", "version"],
+		"Flags:"
+	);
 	wrangler.help().alias("h", "help");
 
 	// Default help command that supports the subcommands
@@ -486,7 +491,7 @@ export function createCLIParser(argv: string[]) {
 				return;
 			}
 			await login({ browser: args.browser });
-			const config = readConfig(args.config as ConfigPath, args);
+			const config = readConfig(args.config, args);
 			await metrics.sendMetricsEvent("login user", {
 				sendMetrics: config.send_metrics,
 			});
@@ -503,10 +508,10 @@ export function createCLIParser(argv: string[]) {
 		"logout",
 		"🚪 Logout from Cloudflare",
 		() => {},
-		async () => {
+		async (args) => {
 			await printWranglerBanner();
 			await logout();
-			const config = readConfig(undefined, {});
+			const config = readConfig(undefined, args);
 			await metrics.sendMetricsEvent("logout user", {
 				sendMetrics: config.send_metrics,
 			});
@@ -518,10 +523,10 @@ export function createCLIParser(argv: string[]) {
 		"whoami",
 		"🕵️  Retrieve your user info and test your auth config",
 		() => {},
-		async () => {
+		async (args) => {
 			await printWranglerBanner();
 			await whoami();
-			const config = readConfig(undefined, {});
+			const config = readConfig(undefined, args);
 			await metrics.sendMetricsEvent("view accounts", {
 				sendMetrics: config.send_metrics,
 			});
@@ -533,9 +538,9 @@ export function createCLIParser(argv: string[]) {
 		"types",
 		"📝 Generate types from bindings & module rules in config",
 		() => {},
-		async () => {
+		async (args) => {
 			await printWranglerBanner();
-			const config = readConfig(undefined, {});
+			const config = readConfig(undefined, args);
 
 			const configBindings: Partial<Config> = {
 				kv_namespaces: config.kv_namespaces ?? [],
@@ -567,20 +572,16 @@ export function createCLIParser(argv: string[]) {
 	wrangler.command(
 		"deployments",
 		"🚢 Displays the 10 most recent deployments for a worker",
-		(yargs) => {
+		(yargs) =>
 			yargs
 				.option("name", {
 					describe: "The name of your worker",
 					type: "string",
 				})
-				.epilogue(deploymentsWarning);
-		},
-		async (deploymentsYargs: ArgumentsCamelCase<{ name: string }>) => {
+				.epilogue(deploymentsWarning),
+		async (deploymentsYargs) => {
 			await printWranglerBanner();
-			const config = readConfig(
-				deploymentsYargs.config as ConfigPath,
-				deploymentsYargs
-			);
+			const config = readConfig(deploymentsYargs.config, deploymentsYargs);
 			const accountId = await requireAuth(config);
 			const scriptName = getScriptName(
 				{ name: deploymentsYargs.name, env: undefined },

package/src/init.ts

@@ -20,16 +20,14 @@ import { CommandLineArgsError, printWranglerBanner } from "./index";
 import type { RawConfig } from "./config";
 import type { Route, SimpleRoute } from "./config/environment";
 import type { WorkerMetadata } from "./create-worker-upload-form";
-import type { ConfigPath } from "./index";
 import type { PackageManager } from "./package-manager";
 import type { PackageJSON } from "./parse";
 import type {
-	CommonYargsOptions,
-	YargsOptionsToInterface,
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
 } from "./yargs-types";
-import type { Argv } from "yargs";
 
-export function initOptions(yargs: Argv<CommonYargsOptions>) {
+export function initOptions(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("name", {
 			describe: "The name of your worker",
@@ -60,7 +58,7 @@ export function initOptions(yargs: Argv<CommonYargsOptions>) {
 		});
 }
 
-type InitArgs = YargsOptionsToInterface<typeof initOptions>;
+type InitArgs = StrictYargsOptionsToInterface<typeof initOptions>;
 
 export type ServiceMetadataRes = {
 	id: string;
@@ -170,7 +168,7 @@ export async function initHandler(args: InitArgs) {
 
 	// If --from-dash, check that script actually exists
 	if (fromDashScriptName) {
-		const config = readConfig(args.config as ConfigPath, args);
+		const config = readConfig(args.config, args);
 		accountId = await requireAuth(config);
 		try {
 			serviceMetadata = await fetchResult<ServiceMetadataRes>(