wrangler 0.0.0-e043479 → 0.0.0-e0850ad1

package/src/config/config.ts

@@ -1,270 +0,0 @@
-import type { Environment, RawEnvironment } from "./environment";
-
-/**
- * This is the static type definition for the configuration object.
- *
- * It reflects 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 1.
- * - `@todo`: there's more work to be done (with details attached).
- */
-export type Config = ConfigFields<Environment> & Environment;
-
-export type RawConfig = Partial<ConfigFields<RawEnvironment>> &
-  RawEnvironment &
-  DeprecatedConfigFields;
-
-export interface ConfigFields<Env extends RawEnvironment> {
-  configPath: string | undefined;
-
-  /**
-   * The entrypoint/path to the JavaScript file that will be executed.
-   */
-  main: string | undefined;
-
-  /**
-   * A boolean to enable "legacy" style wrangler environments (from wrangler 1).
-   * 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;
-
-  /**
-   * 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]: Env;
-  };
-
-  /**
-   * Options to configure the development server that your worker will use.
-   *
-   * @default `{}`
-   */
-  dev: {
-    /**
-     * IP address for the local dev server to listen on,
-     *
-     * @default `127.0.0.1`
-     * @todo this needs to be implemented
-     */
-    ip?: string;
-
-    /**
-     * Port for the local dev server to listen on
-     *
-     * @default `8787`
-     */
-    port?: number;
-
-    /**
-     * Protocol that local wrangler dev server listens to requests on.
-     *
-     * @default `http`
-     * @todo this needs to be implemented
-     */
-    local_protocol?: string;
-
-    /**
-     * Protocol that wrangler dev forwards requests on
-     *
-     * @default `https`
-     * @todo this needs to be implemented
-     */
-    upstream_protocol?: string;
-
-    /**
-     * Host to forward requests to, defaults to the zone of project
-     */
-    host?: string;
-  };
-
-  /**
-   * 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 1.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;
-
-  /**
-   * 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;
-
-  /**
-   * Configures a custom build step to be run by Wrangler when building your Worker.
-   *
-   * Refer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build)
-   * for more details.
-   *
-   * @default {}
-   */
-  build: {
-    /** The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used. */
-    command?: string;
-    /** The directory in which the command is executed. */
-    cwd?: string;
-    /** The directory to watch for changes while using wrangler dev, defaults to the current working directory */
-    watch_dir?: string;
-    /** Deprecated field previously used to configure the build and upload of the script. */
-    upload?: DeprecatedUpload;
-  };
-}
-
-export interface DeprecatedConfigFields {
-  /**
-   * The project "type". A holdover from wrangler 1.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 1.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;
-}
-
-/**
- * Deprecated upload configuration.
- */
-export interface DeprecatedUpload {
-  /**
-   * The format of the Worker script.
-   *
-   * @deprecated We infer the format automatically now.
-   */
-  format?: "modules" | "service-worker";
-
-  /**
-   * The directory you wish to upload your worker from,
-   * relative to the wrangler.toml file.
-   *
-   * Defaults to the directory containing the wrangler.toml file.
-   *
-   * @deprecated
-   * @breaking In wrangler 1, this defaults to ./dist, whereas in wrangler 2 it defaults to ./
-   */
-  dir?: string;
-
-  /**
-   * The path to the Worker script, relative to `upload.dir`.
-   *
-   * @deprecated This will be replaced by a command line argument.
-   */
-  main?: string;
-
-  /**
-   * @deprecated This is now defined at the top level `rules` field.
-   */
-  rules?: Environment["rules"];
-}

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");
-}

package/src/config/environment.ts

@@ -1,305 +0,0 @@
-/**
- * The `Environment` interface declares all the configuration fields that
- * can be specified for an environment.
- *
- * This could be the top-level default environment, or a specific named environment.
- */
-export interface Environment
-  extends EnvironmentInheritable,
-    EnvironmentNonInheritable {}
-
-/**
- * The `EnvironmentInheritable` interface declares all the configuration fields for an environment
- * that can be inherited (and overridden) from the top-level environment.
- */
-interface EnvironmentInheritable {
-  /**
-   * The name of your worker. Alphanumeric + dashes only.
-   *
-   * @inheritable
-   */
-  name: string | undefined;
-
-  /**
-   * This is the ID of the account associated with your zone.
-   * You might have more than one account, so make sure to use
-   * the ID of the account associated with the zone/route you
-   * provide, if you provide one. It can also be specified through
-   * the CLOUDFLARE_ACCOUNT_ID environment variable.
-   *
-   * @inheritable
-   */
-  account_id: string | undefined;
-
-  /**
-   * A date in the form yyyy-mm-dd, which will be used to determine
-   * which version of the Workers runtime is used.
-   *
-   * More details at https://developers.cloudflare.com/workers/platform/compatibility-dates
-   *
-   * @inheritable
-   */
-  compatibility_date: string | undefined;
-
-  /**
-   * A list of flags that enable features from upcoming features of
-   * the Workers runtime, usually used together with compatibility_flags.
-   *
-   * More details at https://developers.cloudflare.com/workers/platform/compatibility-dates
-   *
-   * @inheritable
-   */
-  compatibility_flags: string[];
-
-  /**
-   * Whether we use <name>.<subdomain>.workers.dev to
-   * test and deploy your worker.
-   *
-   * @default `true` (This is a breaking change from wrangler 1)
-   * @breaking
-   * @inheritable
-   */
-  workers_dev: boolean;
-
-  /**
-   * A list of routes that your worker should be published to.
-   * Only one of `routes` or `route` is required.
-   *
-   * Only required when workers_dev is false, and there's no scheduled worker (see `triggers`)
-   *
-   * @inheritable
-   */
-  routes: string[] | undefined;
-
-  /**
-   * A route that your worker should be published to. Literally
-   * the same as routes, but only one.
-   * Only one of `routes` or `route` is required.
-   *
-   * Only required when workers_dev is false, and there's no scheduled worker
-   *
-   * @inheritable
-   */
-  route: string | undefined;
-
-  /**
-   * The function to use to replace jsx syntax.
-   *
-   * @default `"React.createElement"`
-   * @inheritable
-   */
-  jsx_factory: string;
-
-  /**
-   * The function to use to replace jsx fragment syntax.
-   *
-   * @default `"React.Fragment"`
-   * @inheritable
-   */
-  jsx_fragment: string;
-
-  /**
-   * "Cron" definitions to trigger a worker's "scheduled" function.
-   *
-   * Lets you call workers periodically, much like a cron job.
-   *
-   * More details here https://developers.cloudflare.com/workers/platform/cron-triggers
-   *
-   * @default `{crons:[]}`
-   * @inheritable
-   */
-  triggers: { crons: string[] };
-
-  /**
-   * Specifies the Usage Model for your Worker. There are two options -
-   * [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and
-   * [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model).
-   * For newly created Workers, if the Usage Model is omitted
-   * it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model).
-   * For existing Workers, if the Usage Model is omitted, it will be
-   * set to the Usage Model configured in the dashboard for that Worker.
-   *
-   * @inheritable
-   */
-  usage_model: undefined | "bundled" | "unbound";
-
-  /**
-   * An ordered list of rules that define which modules to import,
-   * and what type to import them as. You will need to specify rules
-   * to use Text, Data, and CompiledWasm modules, or when you wish to
-   * have a .js file be treated as an ESModule instead of CommonJS.
-   *
-   * @inheritable
-   */
-  rules: Rule[];
-
-  /**
-   * TODO: remove this as it has been deprecated.
-   *
-   * This is just here for now because the `route` commands use it.
-   * So we need to include it in this type so it is available.
-   */
-  zone_id?: string;
-}
-
-/**
- * The `EnvironmentNonInheritable` interface declares all the configuration fields for an environment
- * that cannot be inherited from the top-level environment, and must be defined specifically.
- *
- * If any of these fields are defined at the top-level then they should also be specifically defined
- * for each named environment.
- */
-interface EnvironmentNonInheritable {
-  /**
-   * A map of environment variables to set when deploying your worker.
-   *
-   * NOTE: This field is not automatically inherited from the top level environment,
-   * and so must be specified in every named environment.
-   *
-   * @default `{}`
-   * @nonInheritable
-   */
-  vars: { [key: string]: unknown };
-
-  /**
-   * A list of durable objects that your worker should be bound to.
-   *
-   * For more information about Durable Objects, see the documentation at
-   * https://developers.cloudflare.com/workers/learning/using-durable-objects
-   *
-   * NOTE: This field is not automatically inherited from the top level environment,
-   * and so must be specified in every named environment.
-   *
-   * @default `{bindings:[]}`
-   * @nonInheritable
-   */
-  durable_objects: {
-    bindings: {
-      /** The name of the binding used to refer to the Durable Object */
-      name: string;
-      /** The exported class name of the Durable Object */
-      class_name: string;
-      /** The script where the Durable Object is defined (if it's external to this worker) */
-      script_name?: string;
-    }[];
-  };
-
-  /**
-   * These specify any Workers KV Namespaces you want to
-   * access from inside your Worker.
-   *
-   * To learn more about KV Namespaces,
-   * see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works
-   *
-   * NOTE: This field is not automatically inherited from the top level environment,
-   * and so must be specified in every named environment.
-   *
-   * @default `[]`
-   * @nonInheritable
-   */
-  kv_namespaces: {
-    /** The binding name used to refer to the KV Namespace */
-    binding: string;
-    /** The ID of the KV namespace */
-    id: string;
-    /** The ID of the KV namespace used during `wrangler dev` */
-    preview_id?: string;
-  }[];
-
-  /**
-   * Specifies R2 buckets that are bound to this Worker environment.
-   *
-   * NOTE: This field is not automatically inherited from the top level environment,
-   * and so must be specified in every named environment.
-   *
-   * @default `[]`
-   * @nonInheritable
-   */
-  r2_buckets: {
-    /** The binding name used to refer to the R2 bucket in the worker. */
-    binding: string;
-    /** The name of this R2 bucket at the edge. */
-    bucket_name: string;
-    /** The preview name of this R2 bucket at the edge. */
-    preview_bucket_name?: string;
-  }[];
-
-  /**
-   * "Unsafe" tables for features that aren't directly supported by wrangler.
-   *
-   * NOTE: This field is not automatically inherited from the top level environment,
-   * and so must be specified in every named environment.
-   *
-   * @default `{ bindings: [] }`
-   * @nonInheritable
-   */
-  unsafe: {
-    /**
-     * A set of bindings that should be put into a Worker's upload metadata without changes. These
-     * can be used to implement bindings for features that haven't released and aren't supported
-     * directly by wrangler or miniflare.
-     *
-     * @default []
-     */
-    bindings: {
-      name: string;
-      type: string;
-      [key: string]: unknown;
-    }[];
-  };
-}
-
-/**
- * The environment configuration properties that have been deprecated.
- */
-interface EnvironmentDeprecated {
-  /**
-   * The zone ID of the zone you want to deploy to. You can find this
-   * in your domain page on the dashboard.
-   *
-   * @deprecated This is unnecessary since we can deduce this from routes directly.
-   */
-  zone_id?: string;
-
-  /**
-   * A list of services that your worker should be bound to.
-   *
-   * @default `[]`
-   * @deprecated DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.
-   */
-  experimental_services?: {
-    /** The binding name used to refer to the Service */
-    name: string;
-    /** The name of the Service being bound */
-    service: string;
-    /** The Service's environment */
-    environment: string;
-  }[];
-}
-
-/**
- * The raw environment configuration that we read from the config file.
- *
- * All the properties are optional, and will be replaced with defaults in the configuration that
- * is used in the rest of the codebase.
- */
-export type RawEnvironment = Partial<Environment> & EnvironmentDeprecated;
-
-/**
- * A bundling resolver rule, defining the modules type for paths that match the specified globs.
- */
-export type Rule = {
-  type: ConfigModuleRuleType;
-  globs: string[];
-  fallthrough?: boolean;
-};
-
-/**
- * The possible types for a `Rule`.
- */
-export type ConfigModuleRuleType =
-  | "ESModule"
-  | "CommonJS"
-  | "CompiledWasm"
-  | "Text"
-  | "Data";

package/src/config/index.ts

@@ -1,52 +0,0 @@
-import { findUpSync } from "find-up";
-import { parseTOML, readFileSync } from "../parse";
-import { normalizeAndValidateConfig } from "./validation";
-import type { Config, RawConfig } from "./config";
-
-export type { Config, RawConfig } from "./config";
-export type {
-  Environment,
-  RawEnvironment,
-  ConfigModuleRuleType,
-} from "./environment";
-
-/**
- * Get the Wrangler configuration; read it from the give `configPath` if available.
- */
-export function readConfig(configPath?: string): Config {
-  let rawConfig: RawConfig = {};
-  if (!configPath) {
-    configPath = findWranglerToml();
-  }
-
-  // Load the configuration from disk if available
-  if (configPath) {
-    rawConfig = parseTOML(readFileSync(configPath), configPath);
-  }
-
-  // Process the top-level configuration.
-  const { config, diagnostics } = normalizeAndValidateConfig(
-    rawConfig,
-    configPath
-  );
-
-  if (diagnostics.hasWarnings()) {
-    console.warn(diagnostics.renderWarnings());
-  }
-  if (diagnostics.hasErrors()) {
-    throw new Error(diagnostics.renderErrors());
-  }
-
-  return config;
-}
-
-/**
- * Find the wrangler.toml file by searching up the file-system
- * from the current working directory.
- */
-export function findWranglerToml(
-  referencePath: string = process.cwd()
-): string | undefined {
-  const configPath = findUpSync("wrangler.toml", { cwd: referencePath });
-  return configPath;
-}