fix: make define-process-env-node-env alias node-env (#3514)

* fix: make define-process-env-node-env alias node-env * test: update snapshots * test: update snapshots * fix: add todo
webpack · Dec 4, 2022 · 346a518 · 346a518
1 parent 3ec7b16
commit 346a518
Show file tree

Hide file tree

Showing 12 changed files with 195 additions and 79 deletions.
diff --git a/OPTIONS.md b/OPTIONS.md
@@ -10,7 +10,8 @@ Options:
   -m, --merge                                                                        Merge two or more configurations using 'webpack-merge'.
   --disable-interpret                                                                Disable interpret for loading the config file.
   --env <value...>                                                                   Environment passed to the configuration when it is a function.
-  --define-process-env-node-env <value>                                              Sets process.env.NODE_ENV to the specified value.
+  --node-env <value>                                                                 Sets process.env.NODE_ENV to the specified value.
+  --define-process-env-node-env <value>                                              Sets process.env.NODE_ENV to the specified value. (Currently an alias for `--node-env`)
   --analyze                                                                          It invokes webpack-bundle-analyzer plugin to get bundle information.
   --progress [value]                                                                 Print compilation progress during build.
   -j, --json [value]                                                                 Prints result as JSON or store it in a file.

diff --git a/SERVE-OPTIONS-v4.md b/SERVE-OPTIONS-v4.md
@@ -9,7 +9,8 @@ Options:
   -m, --merge                                         Merge two or more configurations using 'webpack-merge'.
   --disable-interpret                                 Disable interpret for loading the config file.
   --env <value...>                                    Environment passed to the configuration when it is a function.
-  --define-process-env-node-env <value>               Sets process.env.NODE_ENV to the specified value.
+  --node-env <value>                                  Sets process.env.NODE_ENV to the specified value.
+  --define-process-env-node-env <value>               Sets process.env.NODE_ENV to the specified value. (Currently an alias for `--node-env`)
   --analyze                                           It invokes webpack-bundle-analyzer plugin to get bundle information.
   --progress [value]                                  Print compilation progress during build.
   -j, --json [value]                                  Prints result as JSON or store it in a file.

diff --git a/packages/generators/init-template/default/package.json.js b/packages/generators/init-template/default/package.json.js
@@ -1,8 +1,8 @@
 module.exports = (isUsingDevServer) => {
   const scripts = {
-    build: "webpack --mode=production --define-process-env-node-env=production",
+    build: "webpack --mode=production --node-env=production",
     "build:dev": "webpack --mode=development",
-    "build:prod": "webpack --mode=production --define-process-env-node-env=production",
+    "build:prod": "webpack --mode=production --node-env=production",
     watch: "webpack --watch",
   };
   if (isUsingDevServer) {

diff --git a/packages/generators/init-template/react/package.json.tpl b/packages/generators/init-template/react/package.json.tpl
@@ -3,9 +3,9 @@
   "description": "My webpack project",
   "name": "my-webpack-project",
   "scripts": {
-    "build": "webpack --mode=production --define-process-env-node-env=production",
+    "build": "webpack --mode=production --node-env=production",
     "build:dev": "webpack --mode=development",
-    "build:prod": "webpack --mode=production --define-process-env-node-env=production",
+    "build:prod": "webpack --mode=production --node-env=production",
     "watch": "webpack --watch",
     "serve": "webpack serve"
   }

diff --git a/packages/webpack-cli/README.md b/packages/webpack-cli/README.md
@@ -84,7 +84,8 @@ Options:
   -m, --merge                                      Merge two or more configurations using 'webpack-merge'.
   --disable-interpret                              Disable interpret for loading the config file.
   --env <value...>                                 Environment passed to the configuration when it is a function.
-  --define-process-env-node-env <value>            Sets process.env.NODE_ENV to the specified value.
+  --node-env <value>                               Sets process.env.NODE_ENV to the specified value.
+  --define-process-env-node-env <value>            Sets process.env.NODE_ENV to the specified value. (Currently an alias for `--node-env`)
   --analyze                                        It invokes webpack-bundle-analyzer plugin to get bundle information.
   --progress [value]                               Print compilation progress during build.
   -j, --json [value]                               Prints result as JSON or store it in a file.

diff --git a/packages/webpack-cli/src/webpack-cli.ts b/packages/webpack-cli/src/webpack-cli.ts
@@ -890,7 +890,7 @@ class WebpackCLI implements IWebpackCLI {
         description: "Environment passed to the configuration when it is a function.",
       },
       {
-        name: "define-process-env-node-env",
+        name: "node-env",
         configs: [
           {
             type: "string",
@@ -899,6 +899,17 @@ class WebpackCLI implements IWebpackCLI {
         multiple: false,
         description: "Sets process.env.NODE_ENV to the specified value.",
       },
+      {
+        name: "define-process-env-node-env",
+        configs: [
+          {
+            type: "string",
+          },
+        ],
+        multiple: false,
+        description:
+          "Sets process.env.NODE_ENV to the specified value. (Currently an alias for `--node-env`)",
+      },
 
       // Adding more plugins
       {
@@ -2176,7 +2187,10 @@ class WebpackCLI implements IWebpackCLI {
     callback?: Callback<[Error | undefined, WebpackCLIStats | undefined]>,
   ): Promise<WebpackCompiler> {
     if (typeof options.defineProcessEnvNodeEnv === "string") {
+      // TODO: This should only set NODE_ENV for the runtime not for the config too. Change this during next breaking change.
       process.env.NODE_ENV = options.defineProcessEnvNodeEnv;
+    } else if (typeof options.nodeEnv === "string") {
+      process.env.NODE_ENV = options.nodeEnv;
     }
 
     let config = await this.loadConfig(options);

diff --git a/test/build/node-env/auto-mode.config.js b/test/build/node-env/auto-mode.config.js
@@ -0,0 +1,5 @@
+const WebpackCLITestPlugin = require("../../utils/webpack-cli-test-plugin");
+
+module.exports = {
+  plugins: [new WebpackCLITestPlugin()],
+};
diff --git a/test/build/node-env/node-env.test.js b/test/build/node-env/node-env.test.js
@@ -0,0 +1,68 @@
+"use strict";
+
+const { run } = require("../../utils/test-utils");
+
+describe("--node-env flag", () => {
+  it('should set "process.env.NODE_ENV" to "development"', async () => {
+    const { exitCode, stderr, stdout } = await run(__dirname, ["--node-env", "development"]);
+
+    expect(exitCode).toBe(0);
+    expect(stderr).toBeFalsy();
+    expect(stdout).toContain("mode: 'development'");
+  });
+
+  it('should set "process.env.NODE_ENV" to "production"', async () => {
+    const { exitCode, stderr, stdout } = await run(__dirname, ["--node-env", "production"]);
+
+    expect(exitCode).toBe(0);
+    expect(stderr).toBeFalsy();
+    expect(stdout).toContain("mode: 'production'");
+  });
+
+  it('should set "process.env.NODE_ENV" to "none"', async () => {
+    const { exitCode, stderr, stdout } = await run(__dirname, ["--node-env", "none"]);
+
+    expect(exitCode).toBe(0);
+    expect(stderr).toBeFalsy();
+    expect(stdout).toContain("mode: 'none'");
+  });
+
+  it('should set "process.env.NODE_ENV" and the "mode" option to "development"', async () => {
+    const { exitCode, stderr, stdout } = await run(__dirname, [
+      "--node-env",
+      "development",
+      "--config",
+      "./auto-mode.config.js",
+    ]);
+
+    expect(exitCode).toBe(0);
+    expect(stderr).toBeFalsy();
+    expect(stdout).toContain("mode: 'development'");
+  });
+
+  it('should set "process.env.NODE_ENV" and the "mode" option to "production"', async () => {
+    const { exitCode, stderr, stdout } = await run(__dirname, [
+      "--node-env",
+      "production",
+      "--config",
+      "./auto-mode.config.js",
+    ]);
+
+    expect(exitCode).toBe(0);
+    expect(stderr).toBeFalsy();
+    expect(stdout).toContain("mode: 'production'");
+  });
+
+  it('should set "process.env.NODE_ENV" and the "mode" option to "none"', async () => {
+    const { exitCode, stderr, stdout } = await run(__dirname, [
+      "--node-env",
+      "none",
+      "--config",
+      "./auto-mode.config.js",
+    ]);
+
+    expect(exitCode).toBe(0);
+    expect(stderr).toBeFalsy();
+    expect(stdout).toContain("mode: 'none'");
+  });
+});
diff --git a/test/build/node-env/src/index.js b/test/build/node-env/src/index.js
@@ -0,0 +1 @@
+console.log('--node-env test');
diff --git a/test/build/node-env/webpack.config.js b/test/build/node-env/webpack.config.js
@@ -0,0 +1,6 @@
+const WebpackCLITestPlugin = require("../../utils/webpack-cli-test-plugin");
+
+module.exports = {
+  mode: process.env.NODE_ENV,
+  plugins: [new WebpackCLITestPlugin()],
+};