Skip to content

Commit 1f37434

Browse files
feat: add Vite-compatible import.meta.env defaults (MODE, DEV, PROD, SSR, BASE_URL) (#21440)
* feat: add Vite-compatible import.meta.env defaults Define import.meta.env.MODE, .DEV, .PROD, .SSR and .BASE_URL alongside the existing NODE_ENV default, gated on optimization.nodeEnv. MODE/DEV/PROD derive from mode, SSR from a node (non-browser) platform, BASE_URL from a static output.publicPath. User DefinePlugin/EnvironmentPlugin/DotenvPlugin values still override each key. * test: cover universal target for import.meta.env.SSR Add a web+node universal configCase asserting SSR is false (a universal bundle runs in both environments, so it must not be marked server-only), and reword the changeset to drop the Vite reference. * test: cover function publicPath fallback for import.meta.env.BASE_URL A function publicPath is resolved per-asset at runtime, so BASE_URL has no static value and falls back to "/" (while __webpack_public_path__ stays the runtime value).
1 parent 0558d6e commit 1f37434

17 files changed

Lines changed: 134 additions & 7 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"webpack": minor
3+
---
4+
5+
Add import.meta.env defaults: MODE, DEV, PROD, SSR and BASE_URL.

‎lib/WebpackOptionsApply.js‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -791,10 +791,27 @@ class WebpackOptionsApply extends OptionsApply {
791791
const DefinePlugin = require("./DefinePlugin");
792792

793793
const defValue = JSON.stringify(options.optimization.nodeEnv);
794+
const development = options.mode === "development";
795+
// SSR = server-only build (node, not browser); a universal (node+browser) target is null here, so not SSR.
796+
const ssr =
797+
compiler.platform.node === true && compiler.platform.browser !== true;
798+
const { publicPath } = options.output;
799+
// Vite-compatible base URL; fall back to "/" for runtime ("auto") or empty publicPath.
800+
const baseUrl =
801+
typeof publicPath === "string" &&
802+
publicPath !== "auto" &&
803+
publicPath !== ""
804+
? publicPath
805+
: "/";
794806

795807
new DefinePlugin({
796808
"process.env.NODE_ENV": defValue,
797-
"import.meta.env.NODE_ENV": defValue
809+
"import.meta.env.NODE_ENV": defValue,
810+
"import.meta.env.MODE": defValue,
811+
"import.meta.env.DEV": JSON.stringify(development),
812+
"import.meta.env.PROD": JSON.stringify(!development),
813+
"import.meta.env.SSR": JSON.stringify(ssr),
814+
"import.meta.env.BASE_URL": JSON.stringify(baseUrl)
798815
}).apply(compiler);
799816
}
800817
if (options.optimization.minimize) {

‎test/configCases/module/import-meta-env/__snapshots__/ConfigCacheTest.snap‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ it(\\"should work import.meta.env with DotenvPlugin\\", () => {
1616
1717
it(\\"import.meta.env behaves like process.env\\", async (done) => {
1818
try {
19-
const importMetaEnv = ({\\"AAA\\":\\"aaa\\",\\"WEBPACK_API_URL\\":\\"https://api.example.com\\",\\"NODE_ENV\\":\\"production\\"});
19+
const importMetaEnv = ({\\"AAA\\":\\"aaa\\",\\"WEBPACK_API_URL\\":\\"https://api.example.com\\",\\"NODE_ENV\\":\\"production\\",\\"MODE\\":\\"production\\",\\"DEV\\":false,\\"PROD\\":true,\\"SSR\\":true,\\"BASE_URL\\":\\"/\\"});
2020
importMetaEnv;
2121
const processEnv = process.env;
2222
processEnv;
@@ -27,7 +27,7 @@ it(\\"import.meta.env behaves like process.env\\", async (done) => {
2727
\\"object\\";
2828
typeof process.env;
2929
30-
const { env } = ({env: {\\"AAA\\":\\"aaa\\",\\"WEBPACK_API_URL\\":\\"https://api.example.com\\",\\"NODE_ENV\\":\\"production\\"},});
30+
const { env } = ({env: {\\"AAA\\":\\"aaa\\",\\"WEBPACK_API_URL\\":\\"https://api.example.com\\",\\"NODE_ENV\\":\\"production\\",\\"MODE\\":\\"production\\",\\"DEV\\":false,\\"PROD\\":true,\\"SSR\\":true,\\"BASE_URL\\":\\"/\\"},});
3131
env;
3232
} catch (_e) {
3333
// ignore

‎test/configCases/module/import-meta-env/__snapshots__/ConfigTest.snap‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ it(\\"should work import.meta.env with DotenvPlugin\\", () => {
1616
1717
it(\\"import.meta.env behaves like process.env\\", async (done) => {
1818
try {
19-
const importMetaEnv = ({\\"AAA\\":\\"aaa\\",\\"WEBPACK_API_URL\\":\\"https://api.example.com\\",\\"NODE_ENV\\":\\"production\\"});
19+
const importMetaEnv = ({\\"AAA\\":\\"aaa\\",\\"WEBPACK_API_URL\\":\\"https://api.example.com\\",\\"NODE_ENV\\":\\"production\\",\\"MODE\\":\\"production\\",\\"DEV\\":false,\\"PROD\\":true,\\"SSR\\":true,\\"BASE_URL\\":\\"/\\"});
2020
importMetaEnv;
2121
const processEnv = process.env;
2222
processEnv;
@@ -27,7 +27,7 @@ it(\\"import.meta.env behaves like process.env\\", async (done) => {
2727
\\"object\\";
2828
typeof process.env;
2929
30-
const { env } = ({env: {\\"AAA\\":\\"aaa\\",\\"WEBPACK_API_URL\\":\\"https://api.example.com\\",\\"NODE_ENV\\":\\"production\\"},});
30+
const { env } = ({env: {\\"AAA\\":\\"aaa\\",\\"WEBPACK_API_URL\\":\\"https://api.example.com\\",\\"NODE_ENV\\":\\"production\\",\\"MODE\\":\\"production\\",\\"DEV\\":false,\\"PROD\\":true,\\"SSR\\":true,\\"BASE_URL\\":\\"/\\"},});
3131
env;
3232
} catch (_e) {
3333
// ignore
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
it("should derive import.meta.env.BASE_URL from a static output.publicPath", () => {
2+
expect(import.meta.env.BASE_URL).toBe("/cdn/");
3+
// web target is not a server build
4+
expect(import.meta.env.SSR).toBe(false);
5+
expect(import.meta.env.MODE).toBe("production");
6+
expect(import.meta.env.PROD).toBe(true);
7+
});
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
"use strict";
2+
3+
/** @type {import("../../../../").Configuration} */
4+
module.exports = {
5+
mode: "production",
6+
target: "web",
7+
output: {
8+
publicPath: "/cdn/"
9+
}
10+
};
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
it("should expose Vite-compatible defaults for a development web build", () => {
2+
expect(import.meta.env.NODE_ENV).toBe("development");
3+
expect(import.meta.env.MODE).toBe("development");
4+
expect(import.meta.env.DEV).toBe(true);
5+
expect(import.meta.env.PROD).toBe(false);
6+
// web target is not a server build
7+
expect(import.meta.env.SSR).toBe(false);
8+
});
9+
10+
it("should default import.meta.env.BASE_URL to '/' when publicPath is 'auto'", () => {
11+
expect(import.meta.env.BASE_URL).toBe("/");
12+
});
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
"use strict";
2+
3+
/** @type {import("../../../../").Configuration} */
4+
module.exports = {
5+
mode: "development",
6+
target: "web"
7+
};
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
it("should fall back import.meta.env.BASE_URL to '/' for a function publicPath", () => {
2+
// the function runs at runtime, so there is no static base to expose
3+
expect(import.meta.env.BASE_URL).toBe("/");
4+
expect(__webpack_public_path__).toBe("/from-fn/");
5+
expect(import.meta.env.MODE).toBe("production");
6+
expect(import.meta.env.SSR).toBe(false);
7+
});
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
"use strict";
2+
3+
/** @type {import("../../../../").Configuration} */
4+
module.exports = {
5+
mode: "production",
6+
target: "web",
7+
output: {
8+
// a function publicPath has no static value, so BASE_URL falls back to "/"
9+
publicPath: () => "/from-fn/"
10+
}
11+
};

0 commit comments

Comments
 (0)