From 1dbb5a468d565be067eceef9d10e2e231321cf2f Mon Sep 17 00:00:00 2001 From: Aaron Date: Fri, 18 Oct 2024 10:43:39 -0500 Subject: [PATCH] feat: Add support for `WXT_` environment variable prefix (#1076) --- docs/guide/essentials/config/environment-variables.md | 6 +++--- docs/guide/essentials/config/runtime.md | 4 ++-- packages/wxt/src/core/builders/vite/index.ts | 1 + 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/guide/essentials/config/environment-variables.md b/docs/guide/essentials/config/environment-variables.md index be97952f..ee1e2297 100644 --- a/docs/guide/essentials/config/environment-variables.md +++ b/docs/guide/essentials/config/environment-variables.md @@ -15,14 +15,14 @@ And any environment variables listed inside them will be available at runtime: ```sh # .env -VITE_API_KEY=... +WXT_API_KEY=... ``` ```ts -await fetch(`/some-api?apiKey=${import.meta.env.VITE_API_KEY}`); +await fetch(`/some-api?apiKey=${import.meta.env.WXT_API_KEY}`); ``` -Remember to prefix any environment variables with `VITE_`, otherwise they won't be available at runtime, as per [Vite's convention](https://vite.dev/guide/env-and-mode.html#env-files). +Remember to prefix any environment variables with `WXT_` or `VITE_`, otherwise they won't be available at runtime, as per [Vite's convention](https://vite.dev/guide/env-and-mode.html#env-files). ## Built-in Environment Variables diff --git a/docs/guide/essentials/config/runtime.md b/docs/guide/essentials/config/runtime.md index 084a43f5..2bdd8c8a 100644 --- a/docs/guide/essentials/config/runtime.md +++ b/docs/guide/essentials/config/runtime.md @@ -44,8 +44,8 @@ declare module 'wxt/sandbox' { } export default defineAppConfig({ - apiKey: import.meta.env.VITE_API_KEY, - skipWelcome: import.meta.env.VITE_SKIP_WELCOME === 'true', + apiKey: import.meta.env.WXT_API_KEY, + skipWelcome: import.meta.env.WXT_SKIP_WELCOME === 'true', }); ``` diff --git a/packages/wxt/src/core/builders/vite/index.ts b/packages/wxt/src/core/builders/vite/index.ts index dfe7fc9b..6ab15ab4 100644 --- a/packages/wxt/src/core/builders/vite/index.ts +++ b/packages/wxt/src/core/builders/vite/index.ts @@ -44,6 +44,7 @@ export async function createViteBuilder( config.configFile = false; config.logLevel = 'warn'; config.mode = wxtConfig.mode; + config.envPrefix ??= ['VITE_', 'WXT_']; config.build ??= {}; config.publicDir = wxtConfig.publicDir;