@cloudflare/vite-plugin 0.0.0-29f2076a6 → 0.0.0-2b37abe10

package/README.md

@@ -16,13 +16,32 @@ 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 @cloudflare/vite-plugin wrangler --save-dev
+npm install vite @cloudflare/vite-plugin wrangler --save-dev
 ```
 
-### Add the plugin to your Vite config
+### Create your Vite config file and include the Cloudflare plugin
 
 ```ts
 // vite.config.ts
@@ -40,7 +59,7 @@ export default defineConfig({
 ```toml
 # wrangler.toml
 
-name = "my-worker"
+name = "cloudflare-vite-quick-start"
 compatibility_date = "2024-12-30"
 main = "./src/index.ts"
 ```
@@ -57,7 +76,7 @@ export default {
 };
 ```
 
-You can now develop (`vite dev`), build (`vite build`), preview (`vite preview`), and deploy (`wrangler deploy`) your application.
+You can now develop (`npm run dev`), build (`npm run build`), preview (`npm run preview`), and deploy (`npm exec wrangler deploy`) your application.
 
 ## Tutorial
 
@@ -121,6 +140,15 @@ The `directory` in the output configuration will automatically point to the clie
 > This output file is a snapshot of your configuration at the time of the build and is modified to reference your build artifacts.
 > It is the configuration that is used for preview and deployment.
 
+#### Update the .gitignore file
+
+Wrangler will use and/or generate temporary files that should not be stored in git. Add the following lines to the `.gitignore` file:
+
+```gitignore
+.wrangler
+.dev.vars
+```
+
 #### Run the development server
 
 Run `npm run dev` to verify that your application is working as expected.
@@ -447,6 +475,13 @@ The value of `MY_VAR` will therefore be `'Production var'`.
 If you run `vite build --mode staging` then the 'staging' Vite mode will be used and the 'staging' Cloudflare environment will be selected.
 The value of `MY_VAR` will therefore be `'Staging var'`.
 
+## Secrets
+
+Secrets can be provided to your Worker in local development using a [`.dev.vars`](https://developers.cloudflare.com/workers/configuration/secrets/#local-development-with-secrets) file. If you are using [Cloudflare Environments](#cloudflare-environments) then the relevant `.dev.vars` file will be selected. For example, `CLOUDFLARE_ENV=staging vite dev` will load `.dev.vars.staging` if it exists and fall back to `.dev.vars`.
+
+> [!NOTE]
+> The `vite build` command copies the relevant `.dev.vars[.env-name]` file to the output directory. This is only used when running `vite preview` and is not deployed with your Worker.
+
 ## Migrating from `wrangler dev`
 
 Migrating from `wrangler dev` is a simple process and you can follow the instructions in the [Quick start](#quick-start) to get started.