Update docs for v2.0.0 #115
Merged
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
fjsj
reviewed
Feb 24, 2023
README.md
Outdated
|
|
||
| <br> | ||
| ## Migrating from version 1.x.y to 2.x.y | ||
| Starting on version 2.0.0, when creating a new instance of `BundleTracker`, the usage of the `path` parameter has been fixed and it's now being used to generate the output path for the stats file, together with the `filename` parameter. On version 2.0.0, if the `path` parameter is ommited from the constuctor call, it will use its default value and may end up placing the stats file inside an incorrect directory. To avoid that, when migrating, double-check if the file placement is as expected. The usage of these parameters is documented [here](#usage) and [here](#options). |
There was a problem hiding this comment.
"it will use its default value and may end up placing the stats file inside an incorrect directory." clarify please what the default is: where it places the file.
There was a problem hiding this comment.
Updated this one and the table on the footer to clarify the behavior (that it'll use the output.path before trying to use root directory).
fjsj
reviewed
Feb 24, 2023
README.md
Outdated
| @@ -39,13 +35,13 @@ module.exports = { | |||
| plugins: [ | |||
| new BundleTracker({ | |||
| path: __dirname, | |||
| filename: './assets/webpack-stats.json', | |||
| filename: 'assets/webpack-stats.json', | |||
There was a problem hiding this comment.
perhaps we should always reject dirs in filename?
for the path to work here, we can do path.join(__dirname, 'assets')
There was a problem hiding this comment.
Isolated this behavior on 340dc1a, so we can easily revert if we decide not moving forward with it.
|
@JanMalte could you please review too? |
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.
No description provided.