Skip to content

Commit 6e4a4f4

Browse files
committed
Update README
1 parent 93715d4 commit 6e4a4f4

2 files changed

Lines changed: 7 additions & 8 deletions

File tree

.github/workflows/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: main
1+
name: test
22

33
on:
44
push:

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Webpack Bundle Tracker [![Join the chat at https://gitter.im/owais/webpack-bundle-tracker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/owais/webpack-bundle-tracker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2-
[![master build status](https://github.com/django-webpack/webpack-bundle-tracker/actions/workflows/test.yml/badge.svg)](https://github.com/django-webpack/webpack-bundle-tracker/actions/workflows/test.yml)
1+
# Webpack Bundle Tracker
32

3+
[![master build status](https://github.com/django-webpack/webpack-bundle-tracker/actions/workflows/config.yml/badge.svg)](https://github.com/django-webpack/webpack-bundle-tracker/actions/workflows/config.yml)
44

55
Spits out some stats about webpack compilation process to a file.
66

@@ -16,9 +16,10 @@ This project is compatible with NodeJS versions 16 and up.
1616

1717
:warning: Starting on version 17, NodeJS uses OpenSSL v3 which has compatibility issues with Webpack@4. This isn't an issue for Webpack@5, however
1818
if you're using Node >= 17 and Webpack@4, to properly use this package you must ensure to set the `NODE_OPTIONS=--openssl-legacy-provider` environment
19-
variable. You can read more about this on https://github.com/webpack/webpack/issues/14532.
19+
variable. You can read more about this on https://github.com/webpack/webpack/issues/14532.
2020

2121
## Migrating from version 1.x.y to 2.x.y
22+
2223
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). Also, version 2.0.0 doesn't allow sub-directories to be included on the `filename`, only allowing to include them on the `path` param. To avoid those issues, when migrating, double-check if the file placement is as expected. The usage of these parameters is documented [here](#usage) and [here](#options).
2324

2425
## Usage
@@ -92,9 +93,7 @@ And in case `logTime` option is set to `true`, the output will look like,
9293
{
9394
"status": "done",
9495
"chunks": {
95-
"app": [
96-
"app-0828904584990b611fb8.js"
97-
]
96+
"app": ["app-0828904584990b611fb8.js"]
9897
},
9998
"assets": {
10099
"app-0828904584990b611fb8.js": {
@@ -181,7 +180,7 @@ passed to the `space` parameter in `JSON.stringify`. More information can be fou
181180

182181
| Name | Type | Default | Description |
183182
| ----------------- | ----------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
184-
| `path` | `{String}` | `'.'` | Output directory of bundle tracker JSON file. Will attempt to use `output.path` before falling back to the default value. |
183+
| `path` | `{String}` | `'.'` | Output directory of bundle tracker JSON file. Will attempt to use `output.path` before falling back to the default value. |
185184
| `filename` | `{String}` | `'webpack-stats.json'` | Name of the bundle tracker JSON file. |
186185
| `publicPath` | `{String}` | (ignored) | Override `output.publicPath` from Webpack config. |
187186
| `relativePath` | `{Boolean}` | `false` | Show relative path instead of absolute path for bundles in JSON Tracker file. Path are relative from path of JSON Tracker file. |

0 commit comments

Comments
 (0)