feat!: rename --define-process-env-node-env to --config-node-env

[snitin315]

What kind of change does this PR introduce?
Fix #3503 (comment)

webpack-cli/packages/webpack-cli/src/webpack-cli.ts

Lines 2388 to 2390 in c97779b

	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;

Did you add tests for your changes?
Yes
If relevant, did you update the documentation?
Will update in docs website, I have updated the option descriptions.
Summary

#4318 (comment)

Does this PR introduce a breaking change?
Yes

--define-process-env-node-env was removed in favor of --config-node-env option.

Other information
No

[alexander-akait]

@snitin315 I don't think we need this option anymore anyway. We have - https://github.com/webpack/webpack/blob/main/lib/WebpackOptionsApply.js#L599.

The main problem is that we have two options:

• --node-env (set process.env.NODE_ENV for webpack.config.js)
• --optimization-node-env (set process.env.NODE_ENV for runtime)

And that's why they confuse some developers. The names are almost the same, but they do completely different things.

I think the best solution would be to do the following:

• remove --define-process-env-node-env at all
• we leave --node-env because it is widely used by many
• we come up with a new name for the --node-env variable and updates the documentation so that new developers can use it

Shortly --node-env and ---new-name-node-env work and do the same thing, but the documentation will recommend to use a new name.

To be honest I have no ideas for a new name, so I'd be happy to hear any suggestions 😄

[snitin315]

@alexander-akait how about --config-node-env or --config-only-node-env?

[alexander-akait]

--config-node-env sounds good

[snitin315]

Updated 👍🏻

[c100k]

Hello,

I've just realized one of our production scripts was broken because of this change, after upgrading to 6.x a couple of days ago.

What do you think about adding this as a BREAKING CHANGE in the CHANGELOG of 6.0.0 ?

It will make it easier for everyone to migrate while upgrading. Note that the previous change regarding this flag was mentioned in the CHANGELOG of 5.0.0.

[junhaoliao]

Hello,

I've just realized one of our production scripts was broken because of this change, after upgrading to 6.x a couple of days ago.

What do you think about adding this as a BREAKING CHANGE in the CHANGELOG of 6.0.0 ?

It will make it easier for everyone to migrate while upgrading. Note that the previous change regarding this flag was mentioned in the CHANGELOG of 5.0.0.

I second this. The --define-process-env-node-env option is still mentioned in the README.md, which could lead to confusion.