wrangler 2.8.1 → 2.9.1

package/src/__tests__/worker-namespace.test.ts

@@ -17,7 +17,7 @@ describe("dispatch-namespace", () => {
 	mockAccountId();
 	mockApiToken();
 
-	it("should should display a list of available subcommands, for dispatch-namespace with no subcommand", async () => {
+	it("should display a list of available subcommands, for dispatch-namespace with no subcommand", async () => {
 		await runWrangler("dispatch-namespace");
 
 		// wait a tick for the help menu to be printed
@@ -39,10 +39,11 @@ describe("dispatch-namespace", () => {
 		  wrangler dispatch-namespace rename <old-name> <new-name>  Rename a dispatch namespace
 
 		Flags:
-		  -c, --config   Path to .toml configuration file  [string]
-		  -e, --env      Environment to use for operations and .env files  [string]
-		  -h, --help     Show help  [boolean]
-		  -v, --version  Show version number  [boolean]",
+		  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+		  -c, --config                    Path to .toml configuration file  [string]
+		  -e, --env                       Environment to use for operations and .env files  [string]
+		  -h, --help                      Show help  [boolean]
+		  -v, --version                   Show version number  [boolean]",
 		  "warn": "",
 		}
 	`);
@@ -92,10 +93,11 @@ describe("dispatch-namespace", () => {
 			  name  Name of the dispatch namespace  [string] [required]
 
 			Flags:
-			  -c, --config   Path to .toml configuration file  [string]
-			  -e, --env      Environment to use for operations and .env files  [string]
-			  -h, --help     Show help  [boolean]
-			  -v, --version  Show version number  [boolean]"
+			  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+			  -c, --config                    Path to .toml configuration file  [string]
+			  -e, --env                       Environment to use for operations and .env files  [string]
+			  -h, --help                      Show help  [boolean]
+			  -v, --version                   Show version number  [boolean]"
 		`);
 		});
 
@@ -141,10 +143,11 @@ describe("dispatch-namespace", () => {
 			  name  Name of the dispatch namespace  [string] [required]
 
 			Flags:
-			  -c, --config   Path to .toml configuration file  [string]
-			  -e, --env      Environment to use for operations and .env files  [string]
-			  -h, --help     Show help  [boolean]
-			  -v, --version  Show version number  [boolean]"
+			  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+			  -c, --config                    Path to .toml configuration file  [string]
+			  -e, --env                       Environment to use for operations and .env files  [string]
+			  -h, --help                      Show help  [boolean]
+			  -v, --version                   Show version number  [boolean]"
 		`);
 		});
 
@@ -201,10 +204,11 @@ describe("dispatch-namespace", () => {
 			  name  Name of the dispatch namespace  [string] [required]
 
 			Flags:
-			  -c, --config   Path to .toml configuration file  [string]
-			  -e, --env      Environment to use for operations and .env files  [string]
-			  -h, --help     Show help  [boolean]
-			  -v, --version  Show version number  [boolean]"
+			  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+			  -c, --config                    Path to .toml configuration file  [string]
+			  -e, --env                       Environment to use for operations and .env files  [string]
+			  -h, --help                      Show help  [boolean]
+			  -v, --version                   Show version number  [boolean]"
 		`);
 		});
 
@@ -313,10 +317,11 @@ describe("dispatch-namespace", () => {
 			  new-name  New name of the dispatch namespace  [string] [required]
 
 			Flags:
-			  -c, --config   Path to .toml configuration file  [string]
-			  -e, --env      Environment to use for operations and .env files  [string]
-			  -h, --help     Show help  [boolean]
-			  -v, --version  Show version number  [boolean]"
+			  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+			  -c, --config                    Path to .toml configuration file  [string]
+			  -e, --env                       Environment to use for operations and .env files  [string]
+			  -h, --help                      Show help  [boolean]
+			  -v, --version                   Show version number  [boolean]"
 		`);
 		});
 

package/src/api/dev.ts

@@ -100,7 +100,6 @@ export async function unstable_dev(
 		showInteractiveDevSession,
 		testMode,
 		testScheduled,
-		watch,
 		// 2. options for alpha/beta products/libs
 		d1Databases,
 		experimentalLocal,
@@ -139,20 +138,54 @@ export async function unstable_dev(
 					local: true,
 					d1Databases,
 					disableDevRegistry,
-					testScheduled,
-					experimentalLocal,
-					experimentalLocalRemoteKv,
+					testScheduled: testScheduled ?? false,
+					experimentalLocal: experimentalLocal ?? false,
+					experimentalLocalRemoteKv: experimentalLocalRemoteKv ?? false,
 					enablePagesAssetsServiceBinding,
 					liveReload,
 					showInteractiveDevSession,
 					forceLocal,
-					watch,
-					...options,
 					onReady: (address, port) => {
 						readyPort = port;
 						readyAddress = address;
 						ready(devServer);
 					},
+					config: options?.config,
+					env: options?.env,
+					bundle: options?.bundle,
+					compatibilityDate: options?.compatibilityDate,
+					compatibilityFlags: options?.compatibilityFlags,
+					ip: options?.ip,
+					inspectorPort: options?.inspectorPort,
+					v: undefined,
+					localProtocol: options?.localProtocol,
+					assets: options?.assets,
+					site: options?.site, // Root folder of static assets for Workers Sites
+					siteInclude: options?.siteInclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
+					siteExclude: options?.siteExclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
+					nodeCompat: options?.nodeCompat, // Enable node.js compatibility
+					persist: options?.persist, // Enable persistence for local mode, using default path: .wrangler/state
+					persistTo: options?.persistTo, // Specify directory to use for local persistence (implies --persist)
+					experimentalJsonConfig: undefined,
+					name: undefined,
+					noBundle: false,
+					format: undefined,
+					latest: false,
+					routes: undefined,
+					host: undefined,
+					localUpstream: undefined,
+					experimentalPublic: undefined,
+					upstreamProtocol: undefined,
+					var: undefined,
+					define: undefined,
+					jsxFactory: undefined,
+					jsxFragment: undefined,
+					tsconfig: undefined,
+					minify: undefined,
+					experimentalEnableLocalPersistence: undefined,
+					legacyEnv: undefined,
+					public: undefined,
+					...options,
 				});
 			}).then((devServer) => {
 				// now that the inner promise has resolved, we can resolve the outer promise
@@ -190,22 +223,58 @@ export async function unstable_dev(
 					inspect: false,
 					_: [],
 					$0: "",
+					logLevel: options?.logLevel ?? "log",
+					port: options?.port ?? 0,
 					local: true,
 					showInteractiveDevSession,
 					d1Databases,
 					disableDevRegistry,
-					testScheduled,
-					experimentalLocal,
-					experimentalLocalRemoteKv,
+					testScheduled: testScheduled ?? false,
+					experimentalLocal: experimentalLocal ?? false,
+					experimentalLocalRemoteKv: experimentalLocalRemoteKv ?? false,
 					enablePagesAssetsServiceBinding,
 					liveReload,
-					watch,
-					...options,
 					onReady: (address, port) => {
 						readyPort = port;
 						readyAddress = address;
 						ready(devServer);
 					},
+					config: options?.config,
+					env: options?.env,
+					bundle: options?.bundle,
+					compatibilityDate: options?.compatibilityDate,
+					compatibilityFlags: options?.compatibilityFlags,
+					ip: options?.ip,
+					inspectorPort: options?.inspectorPort,
+					v: undefined,
+					localProtocol: options?.localProtocol,
+					assets: options?.assets,
+					site: options?.site, // Root folder of static assets for Workers Sites
+					siteInclude: options?.siteInclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
+					siteExclude: options?.siteExclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
+					nodeCompat: options?.nodeCompat, // Enable node.js compatibility
+					persist: options?.persist, // Enable persistence for local mode, using default path: .wrangler/state
+					persistTo: options?.persistTo, // Specify directory to use for local persistence (implies --persist)
+					experimentalJsonConfig: undefined,
+					name: undefined,
+					noBundle: false,
+					format: undefined,
+					latest: false,
+					routes: undefined,
+					host: undefined,
+					localUpstream: undefined,
+					experimentalPublic: undefined,
+					upstreamProtocol: undefined,
+					var: undefined,
+					define: undefined,
+					jsxFactory: undefined,
+					jsxFragment: undefined,
+					tsconfig: undefined,
+					minify: undefined,
+					experimentalEnableLocalPersistence: undefined,
+					legacyEnv: undefined,
+					public: undefined,
+					...options,
 				});
 			}).then((devServer) => {
 				resolve({

package/src/api/pages/publish.tsx

@@ -141,6 +141,11 @@ export async function publish({
 	// Routing configuration displayed in the Functions tab of a deployment in Dash
 	let filepathRoutingConfig: string | undefined;
 
+	const d1Databases = Object.keys(
+		project.deployment_configs[isProduction ? "production" : "preview"]
+			.d1_databases ?? {}
+	);
+
 	if (!_workerJS && existsSync(functionsDirectory)) {
 		const outfile = join(tmpdir(), `./functionsWorker-${Math.random()}.js`);
 		const outputConfigPath = join(
@@ -157,10 +162,7 @@ export async function publish({
 				buildOutputDirectory: dirname(outfile),
 				routesOutputPath,
 				local: false,
-				d1Databases: Object.keys(
-					project.deployment_configs[isProduction ? "production" : "preview"]
-						.d1_databases ?? {}
-				),
+				d1Databases,
 			});
 
 			builtFunctions = readFileSync(outfile, "utf-8");
@@ -242,6 +244,7 @@ export async function publish({
 				sourcemap: true,
 				watch: false,
 				onEnd: () => {},
+				betaD1Shims: d1Databases,
 			});
 			workerFileContents = readFileSync(outfile, "utf8");
 		} else {

package/src/bundle.ts

@@ -340,7 +340,7 @@ export async function bundleWorker(
 		sourceRoot: destination,
 		minify,
 		metafile: true,
-		conditions: ["worker", "browser"],
+		conditions: ["workerd", "worker", "browser"],
 		...(process.env.NODE_ENV && {
 			define: {
 				// use process.env["NODE_ENV" + ""] so that esbuild doesn't replace it

package/src/config/config.ts

@@ -1,4 +1,5 @@
 import type { Environment, RawEnvironment } from "./environment";
+import type { CamelCaseKey } from "yargs";
 
 /**
  * This is the static type definition for the configuration object.
@@ -273,3 +274,9 @@ interface EnvironmentMap {
 		[envName: string]: RawEnvironment;
 	};
 }
+
+// API dev only passes in camel-cased versions of keys, so ensure
+// only camel-cased keys are used
+export type OnlyCamelCase<T = Record<string, never>> = {
+	[key in keyof T as CamelCaseKey<key>]: T[key];
+};

package/src/config/index.ts

@@ -2,12 +2,12 @@ import fs from "node:fs";
 import dotenv from "dotenv";
 import { findUpSync } from "find-up";
 import { logger } from "../logger";
-import { parseTOML, readFileSync } from "../parse";
+import { parseJSONC, parseTOML, readFileSync } from "../parse";
 import { removeD1BetaPrefix } from "../worker";
 import { normalizeAndValidateConfig } from "./validation";
 import type { CfWorkerInit } from "../worker";
-import type { Config, RawConfig } from "./config";
-import type { CamelCaseKey } from "yargs";
+import type { CommonYargsOptions } from "../yargs-types";
+import type { Config, OnlyCamelCase, RawConfig } from "./config";
 
 export type {
 	Config,
@@ -25,18 +25,21 @@ export type {
 /**
  * Get the Wrangler configuration; read it from the give `configPath` if available.
  */
-export function readConfig(
+
+export function readConfig<CommandArgs>(
 	configPath: string | undefined,
-	args: unknown
+	// Include command specific args as well as the wrangler global flags
+	args: CommandArgs & OnlyCamelCase<CommonYargsOptions>
 ): Config {
 	let rawConfig: RawConfig = {};
 	if (!configPath) {
-		configPath = findWranglerToml();
+		configPath = findWranglerToml(process.cwd(), args.experimentalJsonConfig);
 	}
-
 	// Load the configuration from disk if available
-	if (configPath) {
+	if (configPath?.endsWith("toml")) {
 		rawConfig = parseTOML(readFileSync(configPath), configPath);
+	} else if (configPath?.endsWith("json")) {
+		rawConfig = parseJSONC(readFileSync(configPath), configPath);
 	}
 
 	// Process the top-level configuration.
@@ -61,10 +64,16 @@ export function readConfig(
  * from the current working directory.
  */
 export function findWranglerToml(
-	referencePath: string = process.cwd()
+	referencePath: string = process.cwd(),
+	preferJson = false
 ): string | undefined {
-	const configPath = findUpSync("wrangler.toml", { cwd: referencePath });
-	return configPath;
+	if (preferJson) {
+		return (
+			findUpSync(`wrangler.json`, { cwd: referencePath }) ??
+			findUpSync(`wrangler.toml`, { cwd: referencePath })
+		);
+	}
+	return findUpSync(`wrangler.toml`, { cwd: referencePath });
 }
 
 /**
@@ -316,18 +325,13 @@ export function printBindings(bindings: CfWorkerInit["bindings"]) {
 	logger.log(message);
 }
 
-type CamelCase<T> = {
-	[key in keyof T as key | CamelCaseKey<key>]: T[key];
-};
-
-export function withConfig<T extends { config?: string }>(
+export function withConfig<T>(
 	handler: (
-		t: Omit<CamelCase<T>, "config"> & { config: Config }
+		t: OnlyCamelCase<T & CommonYargsOptions> & { config: Config }
 	) => Promise<void>
 ) {
-	return (t: CamelCase<T>) => {
-		const { config: configPath, ...rest } = t;
-		return handler({ ...rest, config: readConfig(configPath, rest) });
+	return (t: OnlyCamelCase<T & CommonYargsOptions>) => {
+		return handler({ ...t, config: readConfig(t.config, t) });
 	};
 }
 

package/src/d1/backups.tsx

@@ -11,17 +11,18 @@ import { requireAuth } from "../user";
 import { formatBytes, formatTimeAgo } from "./formatTimeAgo";
 import { Name } from "./options";
 import { d1BetaWarning, getDatabaseByNameOrBinding } from "./utils";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 import type { Backup, Database } from "./types";
 import type { Response } from "undici";
-import type { Argv } from "yargs";
 
-type BackupListArgs = { config?: string; name: string };
-
-export function ListOptions(yargs: Argv): Argv<BackupListArgs> {
+export function ListOptions(yargs: CommonYargsArgv) {
 	return Name(yargs);
 }
-
-export const ListHandler = withConfig<BackupListArgs>(
+type ListHandlerOptions = StrictYargsOptionsToInterface<typeof ListOptions>;
+export const ListHandler = withConfig<ListHandlerOptions>(
 	async ({ config, name }): Promise<void> => {
 		const accountId = await requireAuth({});
 		logger.log(d1BetaWarning);
@@ -77,13 +78,12 @@ export const listBackups = async (
 	return Object.values(results);
 };
 
-type BackupCreateArgs = BackupListArgs;
-
-export function CreateOptions(yargs: Argv): Argv<BackupCreateArgs> {
+export function CreateOptions(yargs: CommonYargsArgv) {
 	return ListOptions(yargs);
 }
+type CreateHandlerOptions = StrictYargsOptionsToInterface<typeof CreateOptions>;
 
-export const CreateHandler = withConfig<BackupCreateArgs>(
+export const CreateHandler = withConfig<CreateHandlerOptions>(
 	async ({ config, name }): Promise<void> => {
 		const accountId = await requireAuth({});
 		logger.log(d1BetaWarning);
@@ -119,19 +119,17 @@ export const createBackup = async (
 	};
 };
 
-type BackupRestoreArgs = BackupListArgs & {
-	"backup-id": string;
-};
-
-export function RestoreOptions(yargs: Argv): Argv<BackupRestoreArgs> {
+export function RestoreOptions(yargs: CommonYargsArgv) {
 	return ListOptions(yargs).positional("backup-id", {
 		describe: "The Backup ID to restore",
 		type: "string",
 		demandOption: true,
 	});
 }
-
-export const RestoreHandler = withConfig<BackupRestoreArgs>(
+type RestoreHandlerOptions = StrictYargsOptionsToInterface<
+	typeof RestoreOptions
+>;
+export const RestoreHandler = withConfig<RestoreHandlerOptions>(
 	async ({ config, name, backupId }): Promise<void> => {
 		const accountId = await requireAuth({});
 		logger.log(d1BetaWarning);
@@ -163,11 +161,7 @@ export const restoreBackup = async (
 	);
 };
 
-type BackupDownloadArgs = BackupRestoreArgs & {
-	output?: string;
-};
-
-export function DownloadOptions(yargs: Argv): Argv<BackupDownloadArgs> {
+export function DownloadOptions(yargs: CommonYargsArgv) {
 	return ListOptions(yargs)
 		.positional("backup-id", {
 			describe: "The Backup ID to download",
@@ -180,8 +174,10 @@ export function DownloadOptions(yargs: Argv): Argv<BackupDownloadArgs> {
 			type: "string",
 		});
 }
-
-export const DownloadHandler = withConfig<BackupDownloadArgs>(
+type DownloadHandlerOptions = StrictYargsOptionsToInterface<
+	typeof DownloadOptions
+>;
+export const DownloadHandler = withConfig<DownloadHandlerOptions>(
 	async ({ name, backupId, output, config }): Promise<void> => {
 		const accountId = await requireAuth({});
 		logger.log(d1BetaWarning);

package/src/d1/create.tsx

@@ -4,12 +4,13 @@ import { fetchResult } from "../cfetch";
 import { logger } from "../logger";
 import { requireAuth } from "../user";
 import { d1BetaWarning } from "./utils";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 import type { Database } from "./types";
-import type { ArgumentsCamelCase, Argv } from "yargs";
 
-type CreateArgs = { name: string };
-
-export function Options(yargs: Argv): Argv<CreateArgs> {
+export function Options(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("name", {
 			describe: "The name of the new DB",
@@ -21,7 +22,7 @@ export function Options(yargs: Argv): Argv<CreateArgs> {
 
 export async function Handler({
 	name,
-}: ArgumentsCamelCase<CreateArgs>): Promise<void> {
+}: StrictYargsOptionsToInterface<typeof Options>): Promise<void> {
 	const accountId = await requireAuth({});
 
 	logger.log(d1BetaWarning);

package/src/d1/delete.ts

@@ -5,16 +5,13 @@ import { logger } from "../logger";
 import { requireAuth } from "../user";
 import { Name } from "./options";
 import { d1BetaWarning, getDatabaseByNameOrBinding } from "./utils";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 import type { Database } from "./types";
-import type { Argv } from "yargs";
 
-type CreateArgs = {
-	config?: string;
-	name: string;
-	"skip-confirmation": boolean;
-};
-
-export function Options(d1ListYargs: Argv): Argv<CreateArgs> {
+export function Options(d1ListYargs: CommonYargsArgv) {
 	return Name(d1ListYargs)
 		.option("skip-confirmation", {
 			describe: "Skip confirmation",
@@ -24,8 +21,8 @@ export function Options(d1ListYargs: Argv): Argv<CreateArgs> {
 		})
 		.epilogue(d1BetaWarning);
 }
-
-export const Handler = withConfig<CreateArgs>(
+type HandlerOptions = StrictYargsOptionsToInterface<typeof Options>;
+export const Handler = withConfig<HandlerOptions>(
 	async ({ name, skipConfirmation, config }): Promise<void> => {
 		const accountId = await requireAuth({});
 		logger.log(d1BetaWarning);