@cloudflare/vite-plugin 0.0.0-e5ebdb143 → 0.0.0-f6cc0293d

package/README.md

@@ -1,6 +1,6 @@
 # `@cloudflare/vite-plugin`
 
-[Intro](#intro) | [Quick start](#quick-start) | [Tutorial](#tutorial) | [API](#api) | [Cloudflare environments](#cloudflare-environments) | [Migrating from `wrangler dev`](#migrating-from-wrangler-dev)
+[Intro](#intro) | [Quick start](#quick-start) | [Tutorial](#tutorial) | [API](#api) | [Cloudflare environments](#worker-environments) | [Migrating from `wrangler dev`](#migrating-from-wrangler-dev)
 
 ## Intro
 
@@ -16,42 +16,23 @@ Your Worker code runs inside [workerd](https://github.com/cloudflare/workerd), m
 
 ## Quick start
 
-### Start with a basic `package.json`
-
-```json
-{
-  "name": "cloudflare-vite-quick-start",
-  "private": true,
-  "version": "0.0.0",
-  "type": "module",
-  "scripts": {
-    "dev": "vite",
-    "build": "vite build",
-    "preview": "vite preview"
-  }
-}
-```
-
-> [!NOTE]
-> Ensure that you include `"type": "module"` in order to use ES modules by default.
-
 ### Install the dependencies
 
 ```sh
-npm install vite @cloudflare/vite-plugin wrangler --save-dev
+npm install @cloudflare/vite-plugin wrangler --save-dev
 ```
 
-### Create your Vite config file and include the Cloudflare plugin
+### Add the plugin to your Vite config
 
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite";
-import { cloudflare } from "@cloudflare/vite-plugin";
+import { defineConfig } from 'vite'
+import { cloudflare } from '@cloudflare/vite-plugin'
 
 export default defineConfig({
   plugins: [cloudflare()],
-});
+})
 ```
 
 ### Create your Worker config file
@@ -59,7 +40,7 @@ export default defineConfig({
 ```toml
 # wrangler.toml
 
-name = "cloudflare-vite-quick-start"
+name = "my-worker"
 compatibility_date = "2024-12-30"
 main = "./src/index.ts"
 ```
@@ -71,12 +52,12 @@ main = "./src/index.ts"
 
 export default {
   fetch() {
-    return new Response(`Running in ${navigator.userAgent}!`);
+    return new Response(`Running in ${navigator.userAgent}!`)
   },
-};
+}
 ```
 
-You can now develop (`npm run dev`), build (`npm run build`), preview (`npm run preview`), and deploy (`npm exec wrangler deploy`) your application.
+You can now develop (`vite dev`), build (`vite build`), preview (`vite preview`), and deploy (`wrangler deploy`) your application.
 
 ## Tutorial
 
@@ -107,13 +88,13 @@ npm install @cloudflare/vite-plugin wrangler --save-dev
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite";
-import react from "@vitejs/plugin-react";
-import { cloudflare } from "@cloudflare/vite-plugin";
+import { defineConfig } from 'vite'
+import react from '@vitejs/plugin-react'
+import { cloudflare } from '@cloudflare/vite-plugin'
 
 export default defineConfig({
   plugins: [react(), cloudflare()],
-});
+})
 ```
 
 #### Create your Worker config file
@@ -200,22 +181,22 @@ The assets `binding` defined here will allow you to access the assets functional
 // api/index.ts
 
 interface Env {
-  ASSETS: Fetcher;
+  ASSETS: Fetcher
 }
 
 export default {
   fetch(request, env) {
-    const url = new URL(request.url);
+    const url = new URL(request.url)
 
-    if (url.pathname.startsWith("/api/")) {
+    if (url.pathname.startsWith('/api/')) {
       return Response.json({
-        name: "Cloudflare",
-      });
+        name: 'Cloudflare',
+      })
     }
 
-    return env.ASSETS.fetch(request);
+    return env.ASSETS.fetch(request)
   },
-} satisfies ExportedHandler<Env>;
+} satisfies ExportedHandler<Env>
 ```
 
 The Worker above will be invoked for any request not matching a static asset.
@@ -230,14 +211,14 @@ Replace the file contents with the following code:
 ```tsx
 // src/App.tsx
 
-import { useState } from "react";
-import reactLogo from "./assets/react.svg";
-import viteLogo from "/vite.svg";
-import "./App.css";
+import { useState } from 'react'
+import reactLogo from './assets/react.svg'
+import viteLogo from '/vite.svg'
+import './App.css'
 
 function App() {
-  const [count, setCount] = useState(0);
-  const [name, setName] = useState("unknown");
+  const [count, setCount] = useState(0)
+  const [name, setName] = useState('unknown')
 
   return (
     <>
@@ -264,9 +245,9 @@ function App() {
       <div className="card">
         <button
           onClick={() => {
-            fetch("/api/")
+            fetch('/api/')
               .then((res) => res.json() as Promise<{ name: string }>)
-              .then((data) => setName(data.name));
+              .then((data) => setName(data.name))
           }}
           aria-label="get name"
         >
@@ -280,10 +261,10 @@ function App() {
         Click on the Vite and React logos to learn more
       </p>
     </>
-  );
+  )
 }
 
-export default App;
+export default App
 ```
 
 Now, if you click the button, it will display 'Name from API is: Cloudflare'.
@@ -329,12 +310,12 @@ The `cloudflare` plugin should be included in the Vite `plugins` array:
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite";
-import { cloudflare } from "@cloudflare/vite-plugin";
+import { defineConfig } from 'vite'
+import { cloudflare } from '@cloudflare/vite-plugin'
 
 export default defineConfig({
   plugins: [cloudflare()],
-});
+})
 ```
 
 It accepts an optional `PluginConfig` parameter.

package/dist/index.d.ts

@@ -19,13 +19,6 @@ interface PluginConfig extends EntryWorkerConfig {
     persistState?: PersistState;
 }
 
-/**
- * Vite plugin that enables a full-featured integration between Vite and the Cloudflare Workers runtime.
- *
- * See the [README](https://github.com/cloudflare/workers-sdk/tree/main/packages/vite-plugin-cloudflare#readme) for more details.
- *
- * @param pluginConfig An optional {@link PluginConfig} object.
- */
 declare function cloudflare(pluginConfig?: PluginConfig): vite.Plugin;
 
 export { cloudflare };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudflare/vite-plugin",
-  "version": "0.0.0-e5ebdb143",
+  "version": "0.0.0-f6cc0293d",
   "description": "Cloudflare plugin for Vite",
   "keywords": [
     "cloudflare",
@@ -36,7 +36,7 @@
     "@hattip/adapter-node": "^0.0.49",
     "unenv": "npm:unenv-nightly@2.0.0-20241218-183400-5d6aec3",
     "ws": "^8.18.0",
-    "miniflare": "0.0.0-e5ebdb143"
+    "miniflare": "0.0.0-f6cc0293d"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20241230.0",
@@ -47,12 +47,12 @@
     "typescript": "^5.7.2",
     "vite": "^6.0.7",
     "@cloudflare/workers-tsconfig": "0.0.0",
-    "@cloudflare/workers-shared": "0.0.0-e5ebdb143",
-    "wrangler": "0.0.0-e5ebdb143"
+    "@cloudflare/workers-shared": "0.0.0-f6cc0293d",
+    "wrangler": "0.0.0-f6cc0293d"
   },
   "peerDependencies": {
     "vite": "^6.0.7",
-    "wrangler": "^3.101.0"
+    "wrangler": "^0.0.0-f6cc0293d"
   },
   "publishConfig": {
     "access": "public"