-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
[DOCS] webpack documentation concept and config section from CommonJS to ESM #7731
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
payelcs2024ipcw-source
wants to merge
5
commits into
webpack:main
Choose a base branch
from
payelcs2024ipcw-source:docs/convert-into-ESM
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6055f19
DOCS: Converted code from commomjs to ES Module
payelcs2024ipcw-source 55a4582
doc:updated-into-ESM
payelcs2024ipcw-source 00500d3
fix: commonjs to ESM
payelcs2024ipcw-source 4b507b7
corrected the code
payelcs2024ipcw-source 28a49cf
corrected codes
payelcs2024ipcw-source File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,15 +26,13 @@ A webpack **plugin** is a JavaScript object that has an [`apply`](https://develo | |
| ```javascript | ||
| const pluginName = 'ConsoleLogOnBuildWebpackPlugin'; | ||
|
|
||
| class ConsoleLogOnBuildWebpackPlugin { | ||
| export default class ConsoleLogOnBuildWebpackPlugin { | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. corrected the typo error |
||
| apply(compiler) { | ||
| compiler.hooks.run.tap(pluginName, (compilation) => { | ||
| compiler.hooks.run.tap(pluginName, () => { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. dont remove the param. |
||
| console.log('The webpack build process is starting!'); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| module.exports = ConsoleLogOnBuildWebpackPlugin; | ||
| ``` | ||
|
|
||
| It is recommended that the first parameter of the tap method of the compiler hook should be a camelized version of the plugin name. It is advisable to use a constant for this so it can be reused in all hooks. | ||
|
|
@@ -50,11 +48,11 @@ Depending on how you are using webpack, there are multiple ways to use plugins. | |
| **webpack.config.js** | ||
|
|
||
| ```javascript | ||
| const HtmlWebpackPlugin = require('html-webpack-plugin'); | ||
| const webpack = require('webpack'); //to access built-in plugins | ||
| const path = require('path'); | ||
| import HtmlWebpackPlugin from 'html-webpack-plugin'); | ||
| import webpack from 'webpack'; //to access built-in plugins | ||
| import path from 'path'; | ||
|
|
||
| module.exports = { | ||
| export default { | ||
| entry: './path/to/my/entry/file.js', | ||
| output: { | ||
| filename: 'my-first-webpack.bundle.js', | ||
|
|
@@ -84,10 +82,10 @@ When using the Node API, you can also pass plugins via the `plugins` property in | |
| **some-node-script.js** | ||
|
|
||
| ```javascript | ||
| const webpack = require('webpack'); //to access webpack runtime | ||
| const configuration = require('./webpack.config.js'); | ||
| import webpack from 'webpack'; //to access webpack runtime | ||
| import configuration from './webpack.config.js'; | ||
|
|
||
| let compiler = webpack(configuration); | ||
| const compiler = webpack(configuration); | ||
|
|
||
| new webpack.ProgressPlugin().apply(compiler); | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
apologies for the oversight earlier. I've double-checked and fixed the typo now. Please let me know if there r further any issues. Thank you.