@cloudflare/vite-plugin 2.0.0-beta.v.8 → 2.0.0-beta.v.9

package/README.md

@@ -18,6 +18,40 @@ export default defineConfig({
 
 Full documentation can be found [here](https://developers.cloudflare.com/workers/vite-plugin/).
 
+## Programmatic configuration
+
+The `config` option accepts a customizer with the signature
+`(loadedConfig: ParsedInputConfigWithWorker) => ParsedInputConfigWithWorker`. It receives the parsed
+`cloudflare.config.ts` configuration, or a default Worker configuration when no
+file exists, and can customize account settings, Containers, and the entry Worker.
+The loaded and returned configurations must include a Worker, even for assets-only projects.
+
+Return a new configuration object, spreading any existing fields you want to
+preserve. Nested objects and arrays are replaced rather than merged:
+
+```ts
+import { cloudflare } from "@cloudflare/vite-plugin";
+
+cloudflare({
+  config(loadedConfig) {
+    return {
+      ...loadedConfig,
+      worker: {
+        ...loadedConfig.worker,
+        env: {
+          ...loadedConfig.worker.env,
+          FRAMEWORK_NAME: { type: "text", value: "my-framework" },
+        },
+      },
+    };
+  },
+});
+```
+
+The customized configuration is recorded in the build output. Preview and
+deployment from that output use the recorded configuration. Generated types
+continue to describe `cloudflare.config.ts`.
+
 ## Features
 
 - Uses the Vite [Environment API](https://vite.dev/guide/api-environment) to integrate Vite with the Workers runtime

package/dist/index.d.mts

@@ -1,9 +1,13 @@
 import * as vite from "vite";
-import { InputWorkerConfig, ParsedInputWorkerConfig, WorkerConfig } from "@cloudflare/config";
+import { InputWorkerConfig, ParsedInputConfig, ParsedInputWorkerConfig, WorkerConfig } from "@cloudflare/config";
 import { CompatDate } from "@cloudflare/workers-utils";
 
 //#region src/plugin-config.d.ts
 
+/** Parsed configuration with the entry Worker required by the Vite plugin. */
+type ParsedInputConfigWithWorker = Omit<ParsedInputConfig, "worker"> & {
+  worker: ParsedInputWorkerConfig;
+};
 type PersistState = boolean | {
   path: string;
 };
@@ -26,7 +30,6 @@ interface BaseWorkerOptions {
  */
 type DevOnly = boolean | (() => boolean);
 interface EntryWorkerOptions extends BaseWorkerOptions {
-  config?: EntryWorkerConfigCustomizer;
   /**
    * Whether the entry Worker should be omitted from the production build.
    * Can be a boolean or a function that returns a boolean. The function is
@@ -64,11 +67,17 @@ interface Experimental {
   /** Experimental support for handling the _headers and _redirects files during Vite dev mode. */
   headersAndRedirectsDevModeSupport?: boolean;
 }
-type EntryWorkerConfigCustomizer = Partial<ParsedInputWorkerConfig> | ((config: ParsedInputWorkerConfig) => Partial<ParsedInputWorkerConfig> | void);
 type WorkerConfigProvider = InputWorkerConfig | ((options: {
   entryWorkerConfig: ParsedInputWorkerConfig;
 }) => InputWorkerConfig);
 interface PluginConfig extends EntryWorkerOptions {
+  /**
+   * Customize the loaded configuration before development or building.
+   * The loaded configuration always includes an entry Worker.
+   * Return a new configuration object including an entry Worker, copying any settings to preserve.
+   * Preview uses the configuration recorded in the build output.
+   */
+  config?: (loadedConfig: ParsedInputConfigWithWorker) => ParsedInputConfigWithWorker;
   auxiliaryWorkers?: AuxiliaryWorkerOptions[];
   /** Configuration for a dedicated prerender Worker. */
   prerenderWorker?: PrerenderWorkerOptions;
@@ -111,4 +120,4 @@ declare function getLocalWorkerdCompatibilityDate(_options?: {
  */
 declare function cloudflare(pluginConfig?: PluginConfig): vite.Plugin[];
 //#endregion
-export { type PluginConfig, type WorkerConfig, cloudflare, getLocalWorkerdCompatibilityDate };
+export { type ParsedInputConfigWithWorker, type PluginConfig, type WorkerConfig, cloudflare, getLocalWorkerdCompatibilityDate };