From 32dc3e73f44cb4e94fb23133d15b1ab19f6715ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Cs=C3=A1sz=C3=A1r?= Date: Sat, 10 Apr 2021 21:00:17 +0200 Subject: [PATCH] Update README for `compressedSize*` options --- README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c5a5bf01..e49a6c18 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,8 @@ new BundleAnalyzerPlugin(options?: object) |**`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).| |**`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.| |**`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.| +|**`compressedSize`**|`{function}`|Default: gzip (with compression level 9). A function of the form `(buffer) => number` that provides a custom computation of the compressed size. For example `(buffer) => zlib.brotliCompressSync(buffer).length`| +|**`compressedSizeLabel`**|`{String}`|Default: `Gzipped`. Content of compressed module size buttons and labels. For example `Brotli`.| |**`openAnalyzer`**|`{Boolean}`|Default: `true`. Automatically open report in default browser.| |**`generateStatsFile`**|`{Boolean}`|Default: `false`. If `true`, webpack stats JSON file will be generated in bundle output directory| |**`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 +113,24 @@ Directory containing all generated bundles. ### `options` ``` - -V, --version output the version number - -m, --mode Analyzer mode. Should be `server`, `static` or `json`. - In `server` mode analyzer will start HTTP server to show bundle report. - In `static` mode single HTML file with bundle report will be generated. - In `json` mode single JSON file with bundle report will be generated. (default: server) - -h, --host Host that will be used in `server` mode to start HTTP server. (default: 127.0.0.1) - -p, --port Port that will be used in `server` mode to start HTTP server. Should be a number or `auto` (default: 8888) - -r, --report Path to bundle report file that will be generated in `static` mode. (default: report.html) - -t, --title String to use in title element of html report. (default: pretty printed current date) - -s, --default-sizes <type> Module sizes to show in treemap by default. - Possible values: stat, parsed, compressed (default: parsed) - -O, --no-open Don't open report in default browser automatically. - -e, --exclude <regexp> Assets that should be excluded from the report. - Can be specified multiple times. - -l, --log-level <level> Log level. - Possible values: debug, info, warn, error, silent (default: info) - -h, --help output usage information + -V, --version output the version number + -m, --mode <mode> Analyzer mode. Should be `server`, `static` or `json`. + In `server` mode analyzer will start HTTP server to show bundle report. + In `static` mode single HTML file with bundle report will be generated. + In `json` mode single JSON file with bundle report will be generated. (default: server) + -h, --host <host> Host that will be used in `server` mode to start HTTP server. (default: 127.0.0.1) + -p, --port <n> Port that will be used in `server` mode to start HTTP server. Should be a number or `auto` (default: 8888) + -r, --report <file> Path to bundle report file that will be generated in `static` mode. (default: report.html) + -t, --title <title> String to use in title element of html report. (default: pretty printed current date) + -s, --default-sizes <type> Module sizes to show in treemap by default. + Possible values: stat, parsed, compressed (default: parsed) + --compressed-size-label <label> String to use for the compressed module size option. (default: Gzipped) + -O, --no-open Don't open report in default browser automatically. + -e, --exclude <regexp> Assets that should be excluded from the report. + Can be specified multiple times. + -l, --log-level <level> Log level. + Possible values: debug, info, warn, error, silent (default: info) + -h, --help output usage information ``` <h2 align="center" id="size-definitions">Size definitions</h2>