Skip to content

Commit 03a7cb5

Browse files
committed
feat: update documentation to include Zstandard compression support
1 parent b420278 commit 03a7cb5

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ _Note: Gaps between patch versions are faulty, broken or test releases._
1212

1313
## UNRELEASED
1414

15+
* **New Feature**
16+
* Add support for Zstandard compression ([#693](https://github.com/webpack-contrib/webpack-bundle-analyzer/pull/693) by [@bjohansebas](https://github.com/bjohansebas))
17+
18+
1519
## 5.1.1
1620

1721
* **Bug Fix**

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This module will help you:
4545
4. Optimize it!
4646

4747
And the best thing is it supports minified bundles! It parses them to get real size of bundled modules.
48-
And it also shows their gzipped or Brotli sizes!
48+
And it also shows their gzipped, Brotli, or Zstandard sizes!
4949

5050
<h2 align="center">Options (for plugin)</h2>
5151

@@ -62,7 +62,7 @@ new BundleAnalyzerPlugin(options?: object)
6262
|**`reportFilename`**|`{String}`|Default: `report.html`. Path to bundle report file that will be generated in `static` mode. It can be either an absolute path or a path relative to a bundle output directory (which is output.path in webpack config).|
6363
|**`reportTitle`**|`{String\|function}`|Default: function that returns pretty printed current date and time. Content of the HTML `title` element; or a function of the form `() => string` that provides the content.|
6464
|**`defaultSizes`**|One of: `stat`, `parsed`, `gzip`, `brotli`|Default: `parsed`. Module sizes to show in report by default. [Size definitions](#size-definitions) section describes what these values mean.|
65-
|**`compressionAlgorithm`**|One of: `gzip`, `brotli`|Default: `gzip`. Compression type used to calculate the compressed module sizes.|
65+
|**`compressionAlgorithm`**|One of: `gzip`, `brotli`, `zstd`|Default: `gzip`. Compression type used to calculate the compressed module sizes.|
6666
|**`openAnalyzer`**|`{Boolean}`|Default: `true`. Automatically open report in default browser.|
6767
|**`generateStatsFile`**|`{Boolean}`|Default: `false`. If `true`, webpack stats JSON file will be generated in bundle output directory|
6868
|**`statsFilename`**|`{String}`|Default: `stats.json`. Name of webpack stats JSON file that will be generated if `generateStatsFile` is `true`. It can be either an absolute path or a path relative to a bundle output directory (which is output.path in webpack config).|
@@ -122,9 +122,9 @@ Directory containing all generated bundles.
122122
-r, --report <file> Path to bundle report file that will be generated in `static` mode. (default: report.html)
123123
-t, --title <title> String to use in title element of html report. (default: pretty printed current date)
124124
-s, --default-sizes <type> Module sizes to show in treemap by default.
125-
Possible values: stat, parsed, gzip, brotli (default: parsed)
125+
Possible values: stat, parsed, gzip, brotli, zstd (default: parsed)
126126
--compression-algorithm <type> Compression algorithm that will be used to calculate the compressed module sizes.
127-
Possible values: gzip, brotli (default: gzip)
127+
Possible values: gzip, brotli, zstd (default: gzip)
128128
-O, --no-open Don't open report in default browser automatically.
129129
-e, --exclude <regexp> Assets that should be excluded from the report.
130130
Can be specified multiple times.
@@ -158,6 +158,10 @@ This is the size of running the parsed bundles/modules through gzip compression.
158158

159159
This is the size of running the parsed bundles/modules through Brotli compression.
160160

161+
### `zstd`
162+
163+
This is the size of running the parsed bundles/modules through Zstandard compression. (Node.js 22.15.0+ is required for this feature)
164+
161165
<h2 align="center">Selecting Which Chunks to Display</h2>
162166

163167
When opened, the report displays all of the Webpack chunks for your project. It's possible to filter to a more specific list of chunks by using the sidebar or the chunk context menu.

0 commit comments

Comments
 (0)