feat(env): add false option for envDir to disable env loading (#19503)

Co-authored-by: 翠 / green <[email protected]>

Author: OnlyWick

docs/config/shared-options.md

@@ -459,10 +459,10 @@ Set to `false` to prevent Vite from clearing the terminal screen when logging ce
 
 ## envDir
 
-- **Type:** `string`
+- **Type:** `string | false`
 - **Default:** `root`
 
-The directory from which `.env` files are loaded. Can be an absolute path, or a path relative to the project root.
+The directory from which `.env` files are loaded. Can be an absolute path, or a path relative to the project root. `false` will disable the `.env` file loading.
 
 See [here](/guide/env-and-mode#env-files) for more about environment files.
 

docs/guide/api-javascript.md

@@ -77,7 +77,6 @@ parentServer.use(vite.middlewares)
 The `InlineConfig` interface extends `UserConfig` with additional properties:
 
 - `configFile`: specify config file to use. If not set, Vite will try to automatically resolve one from project root. Set to `false` to disable auto resolving.
-- `envFile`: Set to `false` to disable `.env` files.
 
 ## `ResolvedConfig`
 

packages/vite/src/node/config.ts

@@ -408,7 +408,7 @@ export interface UserConfig extends DefaultEnvironmentOptions {
    * root.
    * @default root
    */
-  envDir?: string
+  envDir?: string | false
   /**
    * Env variables starts with `envPrefix` will be exposed to your client source code via import.meta.env.
    * @default 'VITE_'
@@ -547,6 +547,7 @@ export interface InlineConfig extends UserConfig {
   configFile?: string | false
   /** @experimental */
   configLoader?: 'bundle' | 'runner' | 'native'
+  /** @deprecated */
   envFile?: false
   forceOptimizeDeps?: boolean
 }
@@ -587,7 +588,7 @@ export interface ResolvedConfig
       /** @internal list of bundle entry id. used to detect recursive worker bundle. */
       bundleChain: string[]
       isProduction: boolean
-      envDir: string
+      envDir: string | false
       env: Record<string, any>
       resolve: Required<ResolveOptions> & {
         alias: Alias[]
@@ -1288,12 +1289,15 @@ export async function resolveConfig(
   )
 
   // load .env files
-  const envDir = config.envDir
-    ? normalizePath(path.resolve(resolvedRoot, config.envDir))
-    : resolvedRoot
-  const userEnv =
-    inlineConfig.envFile !== false &&
-    loadEnv(mode, envDir, resolveEnvPrefix(config))
+  // Backward compatibility: set envDir to false when envFile is false
+  let envDir = config.envFile === false ? false : config.envDir
+  if (envDir !== false) {
+    envDir = config.envDir
+      ? normalizePath(path.resolve(resolvedRoot, config.envDir))
+      : resolvedRoot
+  }
+
+  const userEnv = loadEnv(mode, envDir, resolveEnvPrefix(config))
 
   // Note it is possible for user to have a custom mode, e.g. `staging` where
   // development-like behavior is expected. This is indicated by NODE_ENV=development

packages/vite/src/node/env.ts

@@ -7,18 +7,25 @@ import type { UserConfig } from './config'
 
 const debug = createDebugger('vite:env')
 
-export function getEnvFilesForMode(mode: string, envDir: string): string[] {
-  return [
-    /** default file */ `.env`,
-    /** local file */ `.env.local`,
-    /** mode file */ `.env.${mode}`,
-    /** mode local file */ `.env.${mode}.local`,
-  ].map((file) => normalizePath(path.join(envDir, file)))
+export function getEnvFilesForMode(
+  mode: string,
+  envDir: string | false,
+): string[] {
+  if (envDir !== false) {
+    return [
+      /** default file */ `.env`,
+      /** local file */ `.env.local`,
+      /** mode file */ `.env.${mode}`,
+      /** mode local file */ `.env.${mode}.local`,
+    ].map((file) => normalizePath(path.join(envDir, file)))
+  }
+
+  return []
 }
 
 export function loadEnv(
   mode: string,
-  envDir: string,
+  envDir: string | false,
   prefixes: string | string[] = 'VITE_',
 ): Record<string, string> {
   const start = performance.now()

packages/vite/src/node/server/hmr.ts

@@ -389,7 +389,7 @@ export async function handleHMRUpdate(
   )
 
   const isEnv =
-    config.inlineConfig.envFile !== false &&
+    config.envDir !== false &&
     getEnvFilesForMode(config.mode, config.envDir).includes(file)
   if (isConfig || isConfigDependency || isEnv) {
     // auto restart server

packages/vite/src/node/ssr/__tests__/ssrTransform.spec.ts

@@ -1454,7 +1454,7 @@ const c = () => {
 test('combine mappings', async () => {
   const server = await createServer({
     configFile: false,
-    envFile: false,
+    envDir: false,
     logLevel: 'error',
     plugins: [
       {

packages/vite/src/node/ssr/runnerImport.ts

@@ -21,7 +21,7 @@ export async function runnerImport<T>(
   const config = await resolveConfig(
     mergeConfig(inlineConfig || {}, {
       configFile: false,
-      envFile: false,
+      envDir: false,
       cacheDir: process.cwd(),
       environments: {
         inline: {