Skip to content

Fix docs for printFileSizesAfterBuild #2942

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 16, 2017
Merged

Fix docs for printFileSizesAfterBuild #2942

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c907c6
Fix docs for `printFileSizesAfterBuild`
Kerumen Aug 11, 2017
039403f
Add optionals parameters for `printFileSizesAfterBuild`
Kerumen Aug 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fix docs for printFileSizesAfterBuild
  • Loading branch information
@Kerumen
Kerumen authored Aug 11, 2017
commit 7c907c6dfbb83fa6049114331475bbed50cba831
4 changes: 2 additions & 2 deletions packages/react-dev-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ module: {

Captures JS and CSS asset sizes inside the passed `buildFolder`. Save the result value to compare it after the build.

##### `printFileSizesAfterBuild(webpackStats: WebpackStats, previousFileSizes: OpaqueFileSizes)`
##### `printFileSizesAfterBuild(webpackStats: WebpackStats, previousFileSizes: OpaqueFileSizes, buildFolder: string)`
Copy link
Contributor

@Timer Timer Aug 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! Can you also add maxBundleGzipSize and maxChunkGzipSize as optional fields?

maxBundleGzipSize?: number, maxChunkGzipSize?: number

Copy link
Contributor

@Timer Timer Aug 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping 😄

Copy link
Contributor Author

@Kerumen Kerumen Aug 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes sorry! It's a long week-end here in France (day off) but I do it right when I come back, tonight.

Do you want me to add another phrase to describe the new arguments or I add this in the signature only?

Copy link
Contributor

@Timer Timer Aug 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! A sentence explaining both would be great.

Maybe something like:

maxBundleGzipSize and maxChunkGzipSizemay optionally be specified to display a warning when the main bundle or a chunk exceeds the specified size (in bytes).

Copy link
Contributor Author

@Kerumen Kerumen Aug 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Timer Done! Sorry for the delay :/


Prints the JS and CSS asset sizes after the build, and includes a size comparison with `previousFileSizes` that were captured earlier using `measureFileSizesBeforeBuild()`.

Expand All @@ -182,7 +182,7 @@ var {

measureFileSizesBeforeBuild(buildFolder).then(previousFileSizes => {
return cleanAndRebuild().then(webpackStats => {
printFileSizesAfterBuild(webpackStats, previousFileSizes);
printFileSizesAfterBuild(webpackStats, previousFileSizes, buildFolder);
});
});
```
Expand Down