docs(configuration): update node page for webpack 5 #4078
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/webpack-docs/webpack-js-org/m4qpht8fd |
| --- | ||
|
|
||
| The following Node.js options configure whether to polyfill or mock certain [Node.js globals](https://nodejs.org/docs/latest/api/globals.html) and modules. This allows code originally written for the Node.js environment to run in other environments like the browser. | ||
| The following Node.js options configure whether to polyfill or mock certain [Node.js globals](https://nodejs.org/docs/latest/api/globals.html). |
There was a problem hiding this comment.
node option only defines three Node.js globals now https://github.com/webpack/webpack/blob/60f7ce301df553d8ab0276ba2838ddb60ead1c94/declarations/WebpackOptions.d.ts#L1365, so information related to modules is removed.
There was a problem hiding this comment.
This allows code originally written for the Node.js environment to run in other environments like the browser. was removed as it's not true anymore, we have to polyfill Node.js modules like fs etc. as well, which is described in resolve.fallback section https://github.com/webpack/webpack/blob/master/lib/ModuleNotFoundError.js#L67.
|
|
||
| This feature is provided by webpack's internal [`NodeStuffPlugin`](https://github.com/webpack/webpack/blob/master/lib/NodeStuffPlugin.js) plugin. If the target is "web" (default) or "webworker", the [`NodeSourcePlugin`](https://github.com/webpack/webpack/blob/master/lib/node/NodeSourcePlugin.js) plugin is also activated. |
There was a problem hiding this comment.
NodeSourcePlugin is empty now https://github.com/webpack/webpack/blob/master/lib/node/NodeSourcePlugin.js, so no need to keep.
|
|
||
| T> If you are using a module which needs global variables in it, use `ProvidePlugin` instead of `global`. | ||
|
|
||
| These are the defaults: |
There was a problem hiding this comment.
empty was removed in webpack 5 https://github.com/webpack/webpack/blob/60f7ce301df553d8ab0276ba2838ddb60ead1c94/declarations/WebpackOptions.d.ts#L1369
There was a problem hiding this comment.
I've removed the whole part as I think they're already listed below, there's no need to duplicate them here. But I can revert it if you think it's better to keep.
| - `'mock'`: The fixed value `'/'`. | ||
| - `'eval-only'` |
There was a problem hiding this comment.
It works same as false in my test, but I'm not sure of this value as there's no description in webpack repository.
chenxsan
changed the title
|
|
||
| Defaults to `false` for [targets](/configuration/target/) `node`, `async-node` and `electron-main`. |
There was a problem hiding this comment.
Why remove this? Is there a summary of TARGETS I'm missing, or...?
There was a problem hiding this comment.
I don't remember the specific reason. There're more than three targets having node.global set to false, which could be the reason I removed this.
There was a problem hiding this comment.
The deleted info is outdated, indeed, but why not update it, instead of deleting it? How can I find out what it defaults to without digging into the code?
I'm concerned about this because I actually had an old todo, about improving this page, and by the time I got around to it, somebody already added the defaults, and when I went to look who did it, out of curiosity, I find that it got deleted 😄
There was a problem hiding this comment.
This doesn't encourage me to contribute in this particular case. As it stands, it'll just get deleted a few months later again because of being slightly inaccurate.
There was a problem hiding this comment.
Yeah, it's difficult to align with all changes happening in webpack core project. There will always some stale contents.
The contents for
nodepage changed a lot in webpack 5, so I refactor some.For the sake of review, I've added some comments too.
Preview URL: https://webpack-js-org-git-bugfix-update-node.webpack-docs.vercel.app/configuration/node/