docs: add ProgressPlugin + progress reporting #2293

elliottsj · 2018-06-23T23:01:04Z

To address #2289, add a "Reporting Progress" section to the Plugin API doc, and an article for ProgressPlugin.

EugeneHlushko · 2018-06-25T08:53:37Z

src/content/plugins/progress-plugin.md

+
+## Usage
+
+Create an instance of `ProgressPlugin` with a handler function which will be called when hooks report progress:


This is a showcase within your own plugin right? maybe provide a context e.g.

myPlugin.js

const handler = (percentage, message, ...args) => { .....

It can used inside of a plugin (e.g. progress-bar-webpack-plugin), but ProgressPlugin can also be used standalone, e.g.

// webpack.config.js module.exports = { plugins: [ new ProgressPlugin((percentage, message, ...args) => { console.info(percentage, message, ...args); }) ] };

I'd like to keep the initial "Usage" code snippet simple and consistent with the other plugin pages on the site.

I agree that it would be useful to showcase / link to examples of using ProgressPlugin within a parent plugin. What if I add an "Examples" section and link to ProgressPlugin usage within progress-bar-webpack-plugin / webpack-cli / webpack-command?

the example you gave is much better in my opinion, maybe replace it?

Updated to include the console.info() line.

Do you think I should include the module.exports = { plugins: [ part too? Leaving it out for now for consistency with the other plugin docs

montogeek · 2018-06-25T09:19:01Z

src/content/api/plugins.md

+The `reportProgress` function has this signature:
+
+```js
+reportProgress(percentage: number, ...args: string[]): void;


Please use JS.

Alternatively, add basic JSDoc notation or a link to its Source code.

Now updated to use JS

montogeek · 2018-07-12T21:11:39Z

@EugeneHlushko Any comment on this PR?

EugeneHlushko · 2018-07-18T12:49:52Z

src/content/api/plugins.md

@@ -99,6 +99,36 @@ compiler.hooks.myCustomHook.call(a, b, c);
 Again, see the [documentation](https://github.com/webpack/tapable) for `tapable` to learn more about the
 different hook classes and how they work.

+## Reporting Progress
+
+Plugins can report progress information, which is printed by [the CLI](/api/cli/) when the `--progress` argument is used. More generally, progress information is passed to [`ProgressPlugin`](/plugins/progress-plugin/), which can be used to customize how progress information is reported to the user.


Suggest to remove More generally, . Just go with Progress information... for being clear.

To be honest it doesnt read well the whole paragraph.

Plugins can report progress via ProgressPlugin which prints progress messages by the CLI. In order to enable progress reporting, pass a --progress argument when running webpack.

It is possible to customize the printed output by passing different arguments to the reportProgress function of the ProgressPlugin.

@montogeek what do you think?

Thanks for the feedback, and sorry for the delay!

I'm not sure about the wording of "...ProgressPlugin which prints progress messages by the CLI.", since ProgressPlugin may be used outside of the CLI.

I've updated the wording with yours, but edited this line slightly. Let me know what you think.

EugeneHlushko · 2018-07-18T12:53:53Z

src/content/plugins/progress-plugin.md

+
+T> _Hooks marked with * allow plugins to report progress information using `reportProgress`. For more, see [Plugin API: Reporting Progress](/api/plugins/#reporting-progress)_
+
+### Compiler


this will show in the sidebar menu as Compiler, maybe dont use ### here but just make it bold? Because the name of sidebar entry should say Compiler's hooks which support reporting progress to make sense but it is too long to fit in. I think the previous heading is enough as an entry for the sidebar (Supported Hooks)

EugeneHlushko · 2018-07-18T12:54:53Z

Sorry for late reply, i think its a great addition that needs small tweaks, i did leave two more comments in the changes. Would be nice to get another eye at it, maybe @jeremenichelli has time

montogeek · 2018-08-14T10:50:22Z

@elliottsj Friendly ping

elliottsj · 2018-08-15T14:19:36Z

Hey, sorry for the silence! Been a bit busy the past few weeks, but I'll try to take a look at this this evening.

EugeneHlushko · 2018-08-22T15:27:00Z

src/content/plugins/progress-plugin.md

+* afterOptimizeAssets*
+* afterSeal*
+
+## References


if there are none, just remove this heading

i mean just say Source... or references, dont do two headers in a row please

EugeneHlushko

it looks good, just a minor tweak request if no objections

EugeneHlushko

LGTM, you could also remove _ italic from T> block but it is not that important

EugeneHlushko · 2018-08-22T15:49:49Z

on a side note, please dont squash/ammend commits, easier to review 👍

montogeek · 2018-08-26T13:53:18Z

Thanks!

elliottsj force-pushed the progress-reporting branch 2 times, most recently from 62d838e to ed6c9b4 Compare June 23, 2018 23:03

EugeneHlushko reviewed Jun 25, 2018

View reviewed changes

montogeek requested changes Jun 25, 2018

View reviewed changes

elliottsj force-pushed the progress-reporting branch 2 times, most recently from 34e5ef6 to 1da1470 Compare June 25, 2018 18:47

montogeek approved these changes Jul 12, 2018

View reviewed changes

montogeek added the Plugins label Jul 16, 2018

EugeneHlushko reviewed Jul 18, 2018

View reviewed changes

elliottsj force-pushed the progress-reporting branch from 1da1470 to 5a4fa0c Compare August 22, 2018 14:13

EugeneHlushko reviewed Aug 22, 2018

View reviewed changes

EugeneHlushko requested changes Aug 22, 2018

View reviewed changes

docs: add ProgressPlugin + progress reporting

70874a4

elliottsj force-pushed the progress-reporting branch from 5a4fa0c to 70874a4 Compare August 22, 2018 15:43

EugeneHlushko approved these changes Aug 22, 2018

View reviewed changes

montogeek and others added 3 commits August 23, 2018 15:45

Merge branch 'master' into progress-reporting

b6271ea

Use 4-space indentation

b5867fe

Merge branch 'master' into progress-reporting

e25d2dc

montogeek merged commit b96d505 into webpack:master Aug 26, 2018

elliottsj deleted the progress-reporting branch August 27, 2018 03:01


		## Usage

		Create an instance of `ProgressPlugin` with a handler function which will be called when hooks report progress:


		T> _Hooks marked with * allow plugins to report progress information using `reportProgress`. For more, see [Plugin API: Reporting Progress](/api/plugins/#reporting-progress)_

		### Compiler

Uh oh!

docs: add ProgressPlugin + progress reporting #2293

docs: add ProgressPlugin + progress reporting #2293

Uh oh!

Conversation

elliottsj commented Jun 23, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elliottsj Jun 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montogeek commented Jul 12, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EugeneHlushko commented Jul 18, 2018

Uh oh!

montogeek commented Aug 14, 2018

Uh oh!

elliottsj commented Aug 15, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EugeneHlushko left a comment

Choose a reason for hiding this comment

Uh oh!

EugeneHlushko left a comment

Choose a reason for hiding this comment

Uh oh!

EugeneHlushko commented Aug 22, 2018

Uh oh!

montogeek commented Aug 26, 2018

Uh oh!

Uh oh!

elliottsj Jun 25, 2018 •

edited

Loading