Add on doc custom paths to stats and report files #210
Conversation
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
|
|
|
Thanks! Could you sign the CLA? |
|
@valscion I forgot sorry. |
th0r
requested changes
Sep 15, 2018
README.md
Outdated
| @@ -56,11 +56,11 @@ new BundleAnalyzerPlugin(options?: object) | |||
| |**`analyzerMode`**|One of: `server`, `static`, `disabled`|Default: `server`. In `server` mode analyzer will start HTTP server to show bundle report. In `static` mode single HTML file with bundle report will be generated. In `disabled` mode you can use this plugin to just generate Webpack Stats JSON file by setting `generateStatsFile` to `true`. | | |||
| |**`analyzerHost`**|`{String}`|Default: `127.0.0.1`. Host that will be used in `server` mode to start HTTP server.| | |||
| |**`analyzerPort`**|`{Number}`|Default: `8888`. Port that will be used in `server` mode to start HTTP server.| | |||
| |**`reportFilename`**|`{String}`|Default: `report.html`. Path to bundle report file that will be generated in `static` mode. Relative to bundle output directory (which is `output.path` in webpack config).| | |||
| |**`reportFilename`**|`{String}`|Default: `report.html`. Path to bundle report file that will be generated in `static` mode. Relative to bundle output directory (which is `output.path` in webpack config). Custom path example: `path/to/folder/report.html`. You can generate the `statsFileName` file outside of the bundle output directory by defining an absolute file path.| | |||
There was a problem hiding this comment.
New description says statsFileName, but it should be reportFilename, right?
There was a problem hiding this comment.
Also, maybe we can just say something like Path to bundle report file that will be generated in staticmode. It can be either an absolute path or a path relative to a bundle output directory (which isoutput.path in webpack config).?
leonascimento
force-pushed
the
chore/improve-documentation
branch
from
c3f9ff3
to
0986774
Compare
|
@th0r thank you very much for your help on this code review. |
th0r
requested changes
Sep 18, 2018
README.md
Outdated
| |**`defaultSizes`**|One of: `stat`, `parsed`, `gzip`|Default: `parsed`. Module sizes to show in report by default. [Size definitions](#size-definitions) section describes what these values mean.| | ||
| |**`openAnalyzer`**|`{Boolean}`|Default: `true`. Automatically open report in default browser.| | ||
| |**`generateStatsFile`**|`{Boolean}`|Default: `false`. If `true`, webpack stats JSON file will be generated in bundle output directory| | ||
| |**`statsFilename`**|`{String}`|Default: `stats.json`. Name of webpack stats JSON file that will be generated if `generateStatsFile` is `true`. Relative to bundle output directory.| | ||
| |**`statsFilename`**|`{String}`|Default: `stats.json`. Name of webpack stats JSON file that will be generated if `generateStatsFile` is `true`. Relative to bundle output directory. Custom: `path/to/folder/stats.json`. You can generate the `statsFileName` file outside of the bundle output directory defining the absolute file path.| |
There was a problem hiding this comment.
Can we change it the same way as above?
There was a problem hiding this comment.
Yep. Thanks for your patience and advices.
This pull request should add that we can be able to define the absolute paths to generate the statsFileName or reportFileName. Relates to webpack-contrib#186 webpack-contrib#185
leonascimento
force-pushed
the
chore/improve-documentation
branch
from
0986774
to
c1b4b33
Compare
th0r
approved these changes
Sep 28, 2018
|
Thanks, merged! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request should add that we can be able to
define the absolute paths to generate the statsFileName or
reportFileName.
Relates to #186 #185