wrangler 2.20.0 → 3.0.0

package/src/config/config.ts

@@ -1,282 +0,0 @@
-import type { Environment, RawEnvironment } from "./environment";
-import type { CamelCaseKey } from "yargs";
-
-/**
- * This is the static type definition for the configuration object.
- *
- * It reflects a normalized and validated version of the configuration that you can write in wrangler.toml,
- * and optionally augment with arguments passed directly to wrangler.
- *
- * For more information about the configuration object, see the
- * documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration
- *
- * Notes:
- *
- * - Fields that are only specified in `ConfigFields` and not `Environment` can only appear
- * in the top level config and should not appear in any environments.
- * - All top level fields in config and environments are optional in the wrangler.toml file.
- *
- * Legend for the annotations:
- *
- * - `@breaking`: the deprecation/optionality is a breaking change from Wrangler v1.
- * - `@todo`: there's more work to be done (with details attached).
- */
-export type Config = ConfigFields<DevConfig> & Environment;
-
-export type RawConfig = Partial<ConfigFields<RawDevConfig>> &
-	RawEnvironment &
-	DeprecatedConfigFields &
-	EnvironmentMap;
-
-export interface ConfigFields<Dev extends RawDevConfig> {
-	configPath: string | undefined;
-
-	/**
-	 * A boolean to enable "legacy" style wrangler environments (from Wrangler v1).
-	 * These have been superseded by Services, but there may be projects that won't
-	 * (or can't) use them. If you're using a legacy environment, you can set this
-	 * to `true` to enable it.
-	 */
-	legacy_env: boolean;
-
-	/**
-	 * Whether Wrangler should send usage metrics to Cloudflare for this project.
-	 *
-	 * When defined this will override any user settings.
-	 * Otherwise, Wrangler will use the user's preference.
-	 */
-	send_metrics: boolean | undefined;
-
-	/**
-	 * Options to configure the development server that your worker will use.
-	 */
-	dev: Dev;
-
-	/**
-	 * A list of migrations that should be uploaded with your Worker.
-	 *
-	 * These define changes in your Durable Object declarations.
-	 *
-	 * More details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations
-	 *
-	 * @default `[]`
-	 */
-	migrations: {
-		/** A unique identifier for this migration. */
-		tag: string;
-		/** The new Durable Objects being defined. */
-		new_classes?: string[];
-		/** The Durable Objects being renamed. */
-		renamed_classes?: {
-			from: string;
-			to: string;
-		}[];
-		/** The Durable Objects being removed. */
-		deleted_classes?: string[];
-	}[];
-
-	/**
-	 * The definition of a Worker Site, a feature that lets you upload
-	 * static assets with your Worker.
-	 *
-	 * More details at https://developers.cloudflare.com/workers/platform/sites
-	 */
-	site:
-		| {
-				/**
-				 * The directory containing your static assets.
-				 *
-				 * It must be a path relative to your wrangler.toml file.
-				 * Example: bucket = "./public"
-				 *
-				 * If there is a `site` field then it must contain this `bucket` field.
-				 */
-				bucket: string;
-
-				/**
-				 * The location of your Worker script.
-				 *
-				 * @deprecated DO NOT use this (it's a holdover from Wrangler v1.x). Either use the top level `main` field, or pass the path to your entry file as a command line argument.
-				 * @breaking
-				 */
-				"entry-point"?: string;
-
-				/**
-				 * An exclusive list of .gitignore-style patterns that match file
-				 * or directory names from your bucket location. Only matched
-				 * items will be uploaded. Example: include = ["upload_dir"]
-				 *
-				 * @optional
-				 * @default `[]`
-				 */
-				include?: string[];
-
-				/**
-				 * A list of .gitignore-style patterns that match files or
-				 * directories in your bucket that should be excluded from
-				 * uploads. Example: exclude = ["ignore_dir"]
-				 *
-				 * @optional
-				 * @default `[]`
-				 */
-				exclude?: string[];
-		  }
-		| undefined;
-
-	/**
-	 * Serve a folder of static assets with your Worker, without any additional code.
-	 * This can either be a string, or an object with additional config fields.
-	 */
-	assets:
-		| {
-				bucket: string;
-				include: string[];
-				exclude: string[];
-				browser_TTL: number | undefined;
-				serve_single_page_app: boolean;
-		  }
-		| undefined;
-
-	/**
-	 * A list of wasm modules that your worker should be bound to. This is
-	 * the "legacy" way of binding to a wasm module. ES module workers should
-	 * do proper module imports.
-	 */
-	wasm_modules:
-		| {
-				[key: string]: string;
-		  }
-		| undefined;
-
-	/**
-	 * A list of text files that your worker should be bound to. This is
-	 * the "legacy" way of binding to a text file. ES module workers should
-	 * do proper module imports.
-	 */
-	text_blobs:
-		| {
-				[key: string]: string;
-		  }
-		| undefined;
-
-	/**
-	 * A list of data files that your worker should be bound to. This is
-	 * the "legacy" way of binding to a data file. ES module workers should
-	 * do proper module imports.
-	 */
-	data_blobs:
-		| {
-				[key: string]: string;
-		  }
-		| undefined;
-
-	/**
-	 * By default, wrangler.toml is the source of truth for your environment configuration, like a terraform file.
-	 *
-	 * If you change your vars in the dashboard, wrangler *will* override/delete them on its next publish.
-	 *
-	 * If you want to keep your dashboard vars when wrangler deploys, set this field to true.
-	 *
-	 * @default false
-	 * @nonInheritable
-	 */
-	keep_vars?: boolean;
-}
-
-export interface DevConfig {
-	/**
-	 * IP address for the local dev server to listen on,
-	 *
-	 * @default `0.0.0.0`
-	 */
-	ip: string;
-
-	/**
-	 * Port for the local dev server to listen on
-	 *
-	 * @default `8787`
-	 */
-	port: number | undefined;
-
-	/**
-	 * Port for the local dev server's inspector to listen on
-	 *
-	 * @default `9229`
-	 */
-	inspector_port: number | undefined;
-
-	/**
-	 * Protocol that local wrangler dev server listens to requests on.
-	 *
-	 * @default `http`
-	 */
-	local_protocol: "http" | "https";
-
-	/**
-	 * Protocol that wrangler dev forwards requests on
-	 *
-	 * Setting this to `http` is not currently implemented.
-	 * See https://github.com/cloudflare/workers-sdk/issues/583
-	 *
-	 * @default `https`
-	 * @todo this needs to be implemented https://github.com/cloudflare/workers-sdk/issues/583
-	 */
-	upstream_protocol: "https" | "http";
-
-	/**
-	 * Host to forward requests to, defaults to the host of the first route of project
-	 */
-	host: string | undefined;
-}
-
-export type RawDevConfig = Partial<DevConfig>;
-
-export interface DeprecatedConfigFields {
-	/**
-	 * The project "type". A holdover from Wrangler v1.x.
-	 * Valid values were "webpack", "javascript", and "rust".
-	 *
-	 * @deprecated DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
-	 * @breaking
-	 */
-	type?: "webpack" | "javascript" | "rust";
-
-	/**
-	 * Path to the webpack config to use when building your worker.
-	 * A holdover from Wrangler v1.x, used with `type: "webpack"`.
-	 *
-	 * @deprecated DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.
-	 * @breaking
-	 */
-	webpack_config?: string;
-
-	/**
-	 * Configuration only used by a standalone use of the miniflare binary.
-	 * @deprecated
-	 */
-	miniflare?: unknown;
-}
-
-interface EnvironmentMap {
-	/**
-	 * The `env` section defines overrides for the configuration for different environments.
-	 *
-	 * All environment fields can be specified at the top level of the config indicating the default environment settings.
-	 *
-	 * - Some fields are inherited and overridable in each environment.
-	 * - But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.
-	 *
-	 * For more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments
-	 *
-	 * @default `{}`
-	 */
-	env?: {
-		[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/diagnostics.ts

@@ -1,80 +0,0 @@
-/**
- * Diagnostic errors and warnings.
- *
- * The structure is a tree, where each node can contain zero or more errors, warnings and child diagnostics objects.
- * You can check whether the overall tree has errors or warnings, and you can render a string representation of the errors or warnings.
- */
-export class Diagnostics {
-	errors: string[] = [];
-	warnings: string[] = [];
-	children: Diagnostics[] = [];
-
-	/**
-	 * Create a new Diagnostics object.
-	 * @param description A general description of this collection of messages.
-	 */
-	constructor(public description: string) {}
-
-	/**
-	 * Merge the given `diagnostics` into this as a child.
-	 */
-	addChild(diagnostics: Diagnostics): void {
-		if (diagnostics.hasErrors() || diagnostics.hasWarnings()) {
-			this.children.push(diagnostics);
-		}
-	}
-
-	/** Does this or any of its children have errors. */
-	hasErrors(): boolean {
-		if (this.errors.length > 0) {
-			return true;
-		} else {
-			return this.children.some((child) => child.hasErrors());
-		}
-	}
-
-	/** Render the errors of this and all its children. */
-	renderErrors(): string {
-		return this.render("errors");
-	}
-
-	/** Does this or any of its children have warnings. */
-	hasWarnings(): boolean {
-		if (this.warnings.length > 0) {
-			return true;
-		} else {
-			return this.children.some((child) => child.hasWarnings());
-		}
-	}
-
-	/** Render the warnings of this and all its children. */
-	renderWarnings(): string {
-		return this.render("warnings");
-	}
-
-	private render(field: "errors" | "warnings"): string {
-		const hasMethod = field === "errors" ? "hasErrors" : "hasWarnings";
-		return indentText(
-			`${this.description}\n` +
-				// Output all the fields (errors or warnings) at this level
-				this[field].map((message) => `- ${indentText(message)}`).join("\n") +
-				// Output all the child diagnostics at the next level
-				this.children
-					.map((child) =>
-						child[hasMethod]() ? "\n- " + child.render(field) : ""
-					)
-					.filter((output) => output !== "")
-					.join("\n")
-		);
-	}
-}
-
-/** Indent all the but the first line by two spaces. */
-function indentText(str: string): string {
-	return str
-		.split("\n")
-		.map((line, index) =>
-			(index === 0 ? line : `  ${line}`).replace(/^\s*$/, "")
-		)
-		.join("\n");
-}