pr feedback

remix-run · Jan 18, 2024 · 3e41c29 · 3e41c29
1 parent 42959cc
commit 3e41c29
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 11 deletions.
diff --git a/templates/unstable-vite-cloudflare/.cloudflare/README.md b/templates/unstable-vite-cloudflare/.cloudflare/README.md
@@ -0,0 +1,24 @@
+This directory provides a temporary implementation of CloudFlare's [`getBindingsProxy` API][get-bindings-proxy].
+
+Once [CloudFlare ships that feature][get-bindings-proxy], Remix will export a CloudFlare adapter that you can use:
+
+```ts
+// vite.config.ts
+import { adapter as cloudflare } from "@remix-run/cloudflare";
+import { vitePlugin as remix } from "@remix-run/dev";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  plugins: [
+    remix({
+      adapter: cloudflare({
+        bindings: {
+          /* ... */
+        },
+      }),
+    }),
+  ],
+});
+```
+
+[get-bindings-proxy]: https://github.com/cloudflare/workers-sdk/pull/4523
diff --git a/templates/unstable-vite-cloudflare/.cloudflare/adapter.ts b/templates/unstable-vite-cloudflare/.cloudflare/adapter.ts
@@ -1,17 +1,10 @@
-// Eventually, `getCloudflareDevBindings` will be replaced by the official `getBindingsProxy` API from CloudFlare
-// https://github.com/cloudflare/workers-sdk/pull/4523
-// At that point, Remix will absorb this adapter so you can import it directly in your `vite.config.ts`:
-//
-//   import { adapter as cloudflare } from "@remix-run/cloudflare"
-//
-// Until then, this `.cloudflare/` directory provides the adapter implementation.
-import { DevBindingsOptions, getCloudflareDevBindings } from "./bindings";
+import { DevBindingsOptions, getBindingsProxy } from "./bindings";
 
 export const adapter =
   (options?: { bindings: DevBindingsOptions }) => async () => {
     let bindings: Record<string, unknown> | undefined;
     if (options?.bindings) {
-      bindings = await getCloudflareDevBindings(options.bindings);
+      bindings = await getBindingsProxy(options.bindings);
     }
     let loadContext = bindings && { env: bindings };
     return { loadContext };

diff --git a/templates/unstable-vite-cloudflare/.cloudflare/bindings.ts b/templates/unstable-vite-cloudflare/.cloudflare/bindings.ts
@@ -20,7 +20,7 @@ export type DevBindingsOptions = {
   persist?: false | string;
 };
 
-export async function getCloudflareDevBindings(options: DevBindingsOptions) {
+export async function getBindingsProxy(options: DevBindingsOptions) {
   let mf = await instantiateMiniflare(options);
   let bindings = await mf.getBindings();
   return bindings;

diff --git a/templates/unstable-vite-cloudflare/.cloudflare/index.ts b/templates/unstable-vite-cloudflare/.cloudflare/index.ts
@@ -0,0 +1,2 @@
+// If you're wondering what this code is all about, check out the README.md in this directory!
+export { adapter } from "./adapter";
diff --git a/templates/unstable-vite-cloudflare/vite.config.ts b/templates/unstable-vite-cloudflare/vite.config.ts
@@ -2,7 +2,9 @@ import { unstable_vitePlugin as remix } from "@remix-run/dev";
 import { defineConfig } from "vite";
 import tsconfigPaths from "vite-tsconfig-paths";
 
-import { adapter as cloudflare } from "./.cloudflare/adapter";
+// Check out .cloudflare/README.md for why there's a `.cloudflare` directory in this template
+// In the future, you'll be able to import the `cloudflare` adapter from `@remix-run/cloudflare`
+import { adapter as cloudflare } from "./.cloudflare";
 
 export default defineConfig({
   plugins: [
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// If you're wondering what this code is all about, check out the README.md in this directory!
		export { adapter } from "./adapter";