-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
ProfilingPlugin: add to the docs #1830
Merged
skipjack
merged 4 commits into
webpack:next
from
EugeneHlushko:feature-profiling-plugin
Feb 23, 2018
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
b52643a
ProfilingPlugin: add to the docs
EugeneHlushko db77a55
ProfilingPlugin: add to the docs: small corrections
EugeneHlushko 6688767
ProfilingPlugin: add to the docs: remove redundant code from examples
EugeneHlushko 653f812
ProfilingPlugin: add to the docs: Peer review updates
EugeneHlushko 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 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 |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: ProfilingPlugin | ||
contributors: | ||
- EugeneHlushko | ||
--- | ||
|
||
Generate Chrome profile file which includes timings of plugins execution. Outputs `events.json` file by default. It is possible to provide custom file path using `outputPath` option. | ||
|
||
## Options | ||
|
||
- `outputPath`: A relative path to a custom output file (json) | ||
|
||
## Usage: default | ||
|
||
``` js | ||
new webpack.debug.ProfilingPlugin() | ||
``` | ||
|
||
## Usage: custom `outputPath` | ||
|
||
``` js | ||
new webpack.debug.ProfilingPlugin({ | ||
outputPath: "profiling/profileEvents.json" | ||
}) | ||
``` | ||
|
||
In order to view the profile file: | ||
|
||
- Run webpack with `ProfilingPlugin` | ||
- Go to Chrome, open the `Profile Tab` | ||
- Drag and drop generated file (`events.json` by default) into the profiler. It will then display timeline stats and calls per plugin! | ||
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. I would drop the last sentence to after the bullet points, i.e.
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. yeah sounds good! thank you |
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.
Maybe end these two bullets with periods as they are full sentences.
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.
👍