Skip to content
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

Update docs for v2.0.0 #115

Merged
merged 5 commits into from
May 22, 2023
Merged

Update docs for v2.0.0 #115

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3438b2a
Update docs for v2.0.0
rvlb Feb 24, 2023
fa27fcc
Fix tests after v2.0.0
rvlb Feb 24, 2023
227b499
Improve migrating docs
rvlb Feb 24, 2023
051d882
Add second path fallback to docs
rvlb Feb 24, 2023
340dc1a
Don't allow slashes on filename
rvlb Feb 24, 2023
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
Prev Previous commit
Next Next commit
Add second path fallback to docs
  • Loading branch information
@rvlb
rvlb committed Feb 24, 2023
commit 051d882c033ed42dad3f3dbad54ef360fef4cbfd
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm install --save-dev webpack-bundle-tracker
This project is compatible with NodeJS versions 12 and up.

## 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 attempt to place the stats file at the `output.path` 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).
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 attempt to place the stats file at the `output.path` directory (if also ommited, will use `'.'` as a fallback). 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).

## Usage

Expand Down