wrangler 0.0.0-ece06ea → 0.0.0-edc4b53

package/src/config.ts

@@ -1,124 +1,487 @@
-// we're going to manually write both the type definition AND
-// the validator for the config, so that we can give better error messages
-
-type DOMigration = {
-  tag: string;
-  new_classes?: string[];
-  renamed_classes?: string[];
-  deleted_classes?: string[];
-};
+/**
+ * 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.
+ * The type definition doesn't fully reflect the constraints applied
+ * to the configuration, but it is a good starting point. Later, we
+ * also defined a validator function that will validate the configuration
+ * with the same rules as the type definition, as well as the extra
+ * constraints. The type definition is good for asserting correctness
+ * in the wrangler codebase, whereas the validator function is useful
+ * for signalling errors in the configuration to a user of wrangler.
+ *
+ * For more information about the configuration object, see the
+ * documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration
+ *
+ * Legend for the annotations:
+ *
+ * *:optional means providing a value isn't mandatory
+ * *:deprecated means the field itself isn't necessary anymore in wrangler.toml
+ * *:breaking means the deprecation/optionality is a breaking change from wrangler 1
+ * *:todo means there's more work to be done (with details attached)
+ * *:inherited means the field is copied to all environments
+ */
+export type Config = {
+  /**
+   * The name of your worker. Alphanumeric + dashes only.
+   *
+   * @optional
+   * @inherited
+   */
+  name?: string;
 
-type Project = "webpack" | "javascript" | "rust";
+  /**
+   * The entrypoint/path to the JavaScript file that will be executed.
+   *
+   * @optional
+   * @inherited
+   * @todo this needs to be implemented!
+   */
+  entry?: string;
 
-type Site = {
-  // inherited
-  bucket: string;
-  "entry-point": string;
-  include?: string[];
-  exclude?: string[];
-};
+  /**
+   * 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 CF_ACCOUNT_ID environment variable.
+   *
+   * @optional
+   * @inherited
+   */
+  account_id?: string;
 
-type Dev = {
-  ip?: string;
-  port?: number;
-  local_protocol?: string;
-  upstream_protocol?: string;
-};
+  /**
+   * 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.
+   * @optional
+   * @inherited
+   * @breaking
+   */
+  type?: "webpack" | "javascript" | "rust";
 
-type Vars = { [key: string]: string };
+  /**
+   * 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
+   * @optional true for `dev`, false for `publish`
+   * @inherited
+   */
+  compatibility_date?: string;
 
-type Cron = string; // TODO: we should be able to parse a cron pattern with ts
+  /**
+   * 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
+   *
+   * @optional
+   * @inherited
+   * @todo This could be an enum!
+   */
+  compatibility_flags?: string[];
 
-type KVNamespace = {
-  binding?: string;
-  preview_id: string;
-  id: string;
-};
+  /**
+   * Whether we use <name>.<subdomain>.workers.dev to
+   * test and deploy your worker.
+   *
+   * @default `true` (This is a breaking change from wrangler 1)
+   * @optional
+   * @inherited
+   * @breaking
+   */
+  workers_dev?: boolean;
 
-type DurableObject = {
-  name: string;
-  class_name: string;
-  script_name?: string;
-};
+  /**
+   * 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.
+   * @optional
+   * @inherited
+   */
+  zone_id?: string;
+
+  /**
+   * A list of routes that your worker should be deployed to.
+   * Only one of `routes` or `route` is required.
+   *
+   * @optional false only when workers_dev is false, and there's no scheduled worker
+   * @inherited
+   */
+  routes?: string[];
+
+  /**
+   * A route that your worker should be deployed to. Literally
+   * the same as routes, but only one.
+   * Only one of `routes` or `route` is required.
+   *
+   * @optional false only when workers_dev is false, and there's no scheduled worker
+   * @inherited
+   */
+  route?: string;
+
+  /**
+   * 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.
+   * @inherited
+   * @breaking
+   */
+  webpack_config?: string;
+
+  /**
+   * The function to use to replace jsx syntax.
+   *
+   * @default `"React.createElement"`
+   * @optional
+   * @inherited
+   */
+  jsx_factory?: string;
+
+  /**
+   * The function to use to replace jsx fragment syntax.
+   *
+   * @default `"React.Fragment"`
+   * @optional
+   * @inherited
+   */
+  jsx_fragment?: string;
+
+  /**
+   * A map of environment variables to set when deploying your worker.
+   * Of note, they can only be strings. Which is unfortunate, really.
+   * (TODO: verify that they can only be strings?)
+   * NB: these are not inherited, and HAVE to  be duplicated across all environments.
+   *
+   * @default `{}`
+   * @optional
+   * @inherited false
+   */
+  vars?: { [key: string]: string };
+
+  /**
+   * 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
+   * NB: these are not inherited, and HAVE to be duplicated across all environments.
+   *
+   * @default `{ bindings: [] }`
+   * @optional
+   * @inherited false
+   */
+  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
+   * NB: these are not inherited, and HAVE to be duplicated across all environments.
+   *
+   * @default `[]`
+   * @optional
+   * @inherited false
+   */
+  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;
+  }[];
+
+  /**
+   * A list of services that your worker should be bound to.
+   * NB: these are not inherited, and HAVE to be duplicated across all environments.
+   *
+   * @default `[]`
+   * @optional
+   * @inherited false
+   */
+  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;
+  }[];
+
+  /**
+   * 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
+   * NB: these ARE inherited, and SHOULD NOT be duplicated across all environments.
+   *
+   * @default `[]`
+   * @optional
+   * @inherited true
+   */
+  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
+   * NB: This IS inherited, and SHOULD NOT be duplicated across all environments.
+   *
+   * @default `undefined`
+   * @optional
+   * @inherited true
+   */
+  site?: {
+    /**
+     * The directory containing your static assets. It must be
+     * a path relative to your wrangler.toml file.
+     * Example: bucket = "./public"
+     *
+     * optional false
+     */
+    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 `entry` field, or pass the path to your entry file as a command line argument.
+     * @todo we should use a top level "entry" property instead
+     * @breaking
+     */
+    "entry-point": string;
 
-type Build = {
-  command?: string;
-  cwd?: string;
-  watch_dir?: string;
-} & (
-  | {
-      upload?: {
-        format: "service-worker";
-        main: string;
-      };
-    }
-  | {
-      upload?: {
-        format: "modules";
-        dir?: string;
-        main?: string;
-        rules?: {
-          type: "ESModule" | "CommonJS" | "Text" | "Data" | "CompiledWasm";
-          globs: string[]; // can we use typescript for these patterns?
-          fallthrough?: boolean;
+    /**
+     * 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 `[]`
+     * @todo this needs to be implemented!
+     */
+    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 `[]`
+     * @todo this needs to be implemented!
+     */
+    exclude?: 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
+   *
+   * @inherited
+   * @default `{ crons: [] }`
+   * @optional
+   * @todo can we use typescript for cron patterns?
+   */
+  triggers?: { crons: string[] };
+
+  /**
+   * Options to configure the development server that your worker will use.
+   * NB: This is NOT inherited, and SHOULD NOT be duplicated across all environments.
+   *
+   * @default `{}`
+   * @optional
+   * @inherited false
+   */
+  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;
+  };
+
+  /**
+   * 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.
+   */
+  usage_model?: undefined | "bundled" | "unbound";
+
+  /**
+   * 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 `undefined`
+   * @optional
+   * @inherited false
+   */
+  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;
+  } & /**
+   * Much of the rest of this configuration isn't necessary anymore
+   * in wrangler2. We infer the format automatically, and we can pass
+   * the path to the script either in the CLI (or, @todo, as the top level
+   * `entry` property).
+   */ (
+    | {
+        upload?: {
+          /**
+           * The format of the Worker script, must be "service-worker".
+           *
+           * @deprecated We infer the format automatically now.
+           */
+          format: "service-worker";
+
+          /**
+           * The path to the Worker script. This should be replaced
+           * by the top level `entry' property.
+           *
+           * @deprecated This will be replaced by the top level `entry' property.
+           */
+          main: string;
         };
-      };
-    }
-);
-
-type UsageModel = "bundled" | "unbound";
-
-type Env = {
-  name?: string; // inherited
-  account_id?: string; // inherited
-  workers_dev?: boolean; // inherited
-  compatibility_date?: string; // inherited
-  compatibility_flags?: string[]; // inherited
-  zone_id?: string; // inherited
-  routes?: string[]; // inherited
-  route?: string; // inherited
-  webpack_config?: string; // inherited
-  site?: Site;
-  jsx_factory?: string; // inherited
-  jsx_fragment?: string; // inherited
-  polyfill_node?: boolean; //inherited
-  // we should use typescript to parse cron patterns
-  triggers?: { crons: Cron[] }; // inherited
-  vars?: Vars;
-  durable_objects?: { bindings: DurableObject[] };
-  kv_namespaces?: KVNamespace[];
-  usage_model?: UsageModel; // inherited
-};
+      }
+    | {
+        /**
+         * When we use the module format, we only really
+         * need to specify the entry point. The format is deduced
+         * automatically in wrangler2.
+         */
+        upload?: {
+          /**
+           * The format of the Worker script, must be "modules".
+           *
+           * @deprecated We infer the format automatically now.
+           */
+          format: "modules";
 
-export type Config = {
-  name?: string; // inherited
-  account_id?: string; // inherited
-  // @deprecated Don't use this
-  type?: Project; // top level
-  compatibility_date?: string; // inherited
-  compatibility_flags?: string[]; // inherited
-  // -- there's some mutually exclusive logic for this next block,
-  // but I didn't bother for now
-  workers_dev?: boolean; // inherited
-  zone_id?: string; // inherited
-  routes?: string[]; // inherited
-  route?: string; // inherited
-  // -- end mutually exclusive stuff
-  // @deprecated Don't use this
-  webpack_config?: string; // inherited
-  jsx_factory?: string; // inherited
-  jsx_fragment?: string; // inherited
-  polyfill_node?: boolean; //inherited
-  vars?: Vars;
-  migrations?: DOMigration[];
-  durable_objects?: { bindings: DurableObject[] };
-  kv_namespaces?: KVNamespace[];
-  site?: Site; // inherited
-  // we should use typescript to parse cron patterns
-  triggers?: { crons: Cron[] }; // inherited
-  dev?: Dev;
-  usage_model?: UsageModel; // inherited
-  // top level
-  build?: Build;
-  env?: { [envName: string]: void | Env };
+          /**
+           * The directory you wish to upload your modules from,
+           * defaults to the dist relative to the project root directory.
+           *
+           * @deprecated
+           * @breaking
+           */
+          dir?: string;
+
+          /**
+           * The path to the Worker script. This should be replaced
+           * by the top level `entry' property.
+           *
+           * @deprecated This will be replaced by the top level `entry' property.
+           */
+          main?: string;
+
+          /**
+           * 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.
+           *
+           * @deprecated These are now inferred automatically for major file types, but you can still specify them manually.
+           * @todo this needs to be implemented!
+           * @breaking
+           */
+          rules?: {
+            type: "ESModule" | "CommonJS" | "Text" | "Data" | "CompiledWasm";
+            globs: string[];
+            fallthrough?: boolean;
+          };
+        };
+      }
+  );
+
+  /**
+   * The `env` section defines overrides for the configuration for
+   * different environments. Most fields can be overridden, while
+   * some have to be specifically duplicated in every environment.
+   * For more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments
+   */
+  env?: {
+    [envName: string]:
+      | undefined
+      | Omit<Config, "env" | "migrations" | "site" | "dev">;
+  };
 };
+
+type ValidationResults = (
+  | { key: string; info: string }
+  | { key: string; error: string }
+  | { key: string; warning: string }
+)[];
+
+/**
+ * We also define a validation function that manually validates
+ * every field in the configuration as per the type definitions,
+ * as well as extra constraints we apply to some fields, as well
+ * as some constraints on combinations of fields. This is useful for
+ * presenting errors and messages to the user. Eventually, we will
+ * combine this with some automatic config rewriting tools.
+ *
+ */
+export async function validateConfig(
+  _config: Partial<Config>
+): Promise<ValidationResults> {
+  const results: ValidationResults = [];
+
+  return results;
+}