Skip to content

Commit 1f96f6c

Browse files
smelukovmontogeekEugeneHlushko
authored
Improve progress plugin docs (#3520)
* docs(plugins): improve progress plugin docs (closes #3519) * docs(plugins): improve progress-plugin.md * Apply suggestions from code review Co-Authored-By: Eugene Hlushko <[email protected]> Co-authored-by: Fernando Montoya <[email protected]> Co-authored-by: Eugene Hlushko <[email protected]>
1 parent d759fc1 commit 1f96f6c

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

src/content/plugins/progress-plugin.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ contributors:
44
- elliottsj
55
- EugeneHlushko
66
- byzyk
7+
- smelukov
78
---
89

910
`
@@ -39,26 +40,33 @@ new webpack.ProgressPlugin(handler);
3940

4041
When providing an `object` to the `ProgressPlugin`, following properties are supported:
4142

42-
- `activeModules` show's active modules count and one active module in progress message
43-
- `entries` show's entries count in progress message
44-
- [`handler: function (percentage, message, ...args)`](#providing-function)
45-
- `modules` show's modules count in progress message
46-
- `modulesCount` a minimum modules count to start with. Takes effect when `modules` property is enabled.
47-
- `profile` tells `ProgressPlugin` to collect profile data for progress steps.
48-
43+
- `activeModules` (`boolean = false`): Shows active modules count and one active module in progress message.
44+
- `entries` (`boolean = true`): Shows entries count in progress message.
45+
- `handler` (See [Providing function](#providing-function))
46+
- `modules` (`boolean = true`): Shows modules count in progress message.
47+
- `modulesCount` (`number = 5000`): A minimum modules count to start with. Takes effect when `modules` property is enabled.
48+
- `profile` (`boolean = false`): Tells `ProgressPlugin` to collect profile data for progress steps.
49+
- `dependencies` (`boolean = true`): Shows the count of dependencies in progress message.
50+
- `dependenciesCount` (`number = 10000`): A minimum dependencies count to start with. Takes effect when `dependencies` property is enabled.
51+
- `percentBy` (`string = null: 'entries' | 'dependencies' | 'modules' | null`): Tells `ProgressPlugin` how to calculate progress percentage.
4952

5053
```js
5154
new webpack.ProgressPlugin({
55+
activeModules: false,
5256
entries: true,
53-
modules: true,
54-
modulesCount: 100,
55-
profile: true,
56-
handler: (percentage, message, ...args) => {
57+
handler(percentage, message, ...args) {
5758
// custom logic
58-
}
59+
},
60+
modules: true,
61+
modulesCount: 5000,
62+
profile: false,
63+
dependencies: true,
64+
dependenciesCount: 10000,
65+
percentBy: null
5966
});
6067
```
6168

69+
> We recommend using `percentBy: 'entries'` setting for projects with [multiple configured entry points](/configuration/entry-context/#entry). Percentage calculation will become more accurate because the amount of entry points is known in advance.
6270
6371
## Supported Hooks
6472

0 commit comments

Comments
 (0)