Skip to content

Commit 70d8cf1

Browse files
committed
Add compression algorithm options to README
1 parent 80511a8 commit 70d8cf1

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This module will help you:
4646
4. Optimize it!
4747

4848
And the best thing is it supports minified bundles! It parses them to get real size of bundled modules.
49-
And it also shows their gzipped sizes!
49+
And it also shows their gzipped or Brotli sizes!
5050

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

@@ -62,6 +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`, `compressed`|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.|
6566
|**`openAnalyzer`**|`{Boolean}`|Default: `true`. Automatically open report in default browser.|
6667
|**`generateStatsFile`**|`{Boolean}`|Default: `false`. If `true`, webpack stats JSON file will be generated in bundle output directory|
6768
|**`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).|
@@ -111,23 +112,25 @@ Directory containing all generated bundles.
111112
### `options`
112113

113114
```
114-
-V, --version output the version number
115-
-m, --mode <mode> Analyzer mode. Should be `server`, `static` or `json`.
116-
In `server` mode analyzer will start HTTP server to show bundle report.
117-
In `static` mode single HTML file with bundle report will be generated.
118-
In `json` mode single JSON file with bundle report will be generated. (default: server)
119-
-h, --host <host> Host that will be used in `server` mode to start HTTP server. (default: 127.0.0.1)
120-
-p, --port <n> Port that will be used in `server` mode to start HTTP server. Should be a number or `auto` (default: 8888)
121-
-r, --report <file> Path to bundle report file that will be generated in `static` mode. (default: report.html)
122-
-t, --title <title> String to use in title element of html report. (default: pretty printed current date)
123-
-s, --default-sizes <type> Module sizes to show in treemap by default.
124-
Possible values: stat, parsed, compressed (default: parsed)
125-
-O, --no-open Don't open report in default browser automatically.
126-
-e, --exclude <regexp> Assets that should be excluded from the report.
127-
Can be specified multiple times.
128-
-l, --log-level <level> Log level.
129-
Possible values: debug, info, warn, error, silent (default: info)
130-
-h, --help output usage information
115+
-V, --version output the version number
116+
-m, --mode <mode> Analyzer mode. Should be `server`, `static` or `json`.
117+
In `server` mode analyzer will start HTTP server to show bundle report.
118+
In `static` mode single HTML file with bundle report will be generated.
119+
In `json` mode single JSON file with bundle report will be generated. (default: server)
120+
-h, --host <host> Host that will be used in `server` mode to start HTTP server. (default: 127.0.0.1)
121+
-p, --port <n> Port that will be used in `server` mode to start HTTP server. Should be a number or `auto` (default: 8888)
122+
-r, --report <file> Path to bundle report file that will be generated in `static` mode. (default: report.html)
123+
-t, --title <title> String to use in title element of html report. (default: pretty printed current date)
124+
-s, --default-sizes <type> Module sizes to show in treemap by default.
125+
Possible values: stat, parsed, compressed (default: parsed)
126+
--compression-algorithm <type> Compression algorithm that will be used to calculate the compressed module sizes.
127+
Possible values: gzip, brotli (default: gzip)
128+
-O, --no-open Don't open report in default browser automatically.
129+
-e, --exclude <regexp> Assets that should be excluded from the report.
130+
Can be specified multiple times.
131+
-l, --log-level <level> Log level.
132+
Possible values: debug, info, warn, error, silent (default: info)
133+
-h, --help output usage information
131134
```
132135

133136
<h2 align="center" id="size-definitions">Size definitions</h2>

0 commit comments

Comments
 (0)