Miss any of our Open RFC calls?Watch the recordings here! »

gzipper

4.3.0 • Public • Published

Gzipper

Build Status npm version codecov

A tool for compressing files by means of Brotli and Gzip algorithms, works seamlessly with many CLI UI tools (Angular CLI, Vue CLI, create-react-app).

The flexibility of the algorithms could be extended by many options flags, including the gzip-level, gzip-strategy, gzip-memory-level, brotli-param-mode, brotli-quality, brotli-size-hint. All flags can be declared via ENV variables (ENV variables have higher priority over CLI arguments).

You can enable verbose mode for better visual representation, customize your file output using output-file-format or compress with incremental flag if you have a lot of files that rarely change.

By default gzipper compress all the files but you could use include or exclude options for better flexibility.

Install

  • Globally

npm i gzipper -g

  • Locally to devDependencies.

npm i gzipper -D

Usage

Gzipper

Usage: gzipper [options] [command]
 
Options:
  -V, --version                             output the version number
  -h, --help                                display help for command
 
Commands:
  compress|c [options] <path> [outputPath]  compress selected path and optionally set output directory
  cache                                     manipulations with cache
  help [command]                            display help for command

Compress|c

Usage: gzipper compress|c [options] <path> [outputPath]
 
compress selected path and optionally set output directory
 
Options:
  -v, --verbose                 detailed level of logs
  --incremental                 (beta) incremental compression
  -e, --exclude <extensions>    exclude file extensions from compression, example: jpeg,jpg...
  -i, --include <extensions>    include file extensions for compression, example: js,css,html...
  -t, --threshold <number>      exclude assets smaller than this byte size. 0 (default)
  --level <number>              compression level 6 (default), 0 (no compression) - 9 (best compression)
  --memory-level <number>       amount of memory which will be allocated for compression 8 (default), 1 (minimum memory) - 9 (maximum memory)
  --strategy <number>           compression strategy 0 (default), 1 (filtered), 2 (huffman only), 3 (RLE), 4 (fixed)
  --deflate                     enable deflate compression
  --brotli                      enable brotli compression, Node.js >= v11.7.0
  --brotli-param-mode <value>   default, text (for UTF-8 text), font (for WOFF 2.0 fonts)
  --brotli-quality <number>     brotli compression quality 11 (default), 0 - 11
  --brotli-size-hint <number>   expected input size 0 (default)
  --output-file-format <value>  output file format with default artifacts [filename].[ext].[compressExt]
  --remove-larger               remove compressed files if they larger than uncompressed originals
  -h, --help                    display help for command

Cache

Usage: gzipper cache [options] [command]
 
manipulations with cache
 
Options:
  -h, --help      display help for command
 
Commands:
  purge           purge cache storage
  size            size of cached resources
  help [command]  display help for command

Examples

CLI

  • Globally usage

    gzipper compress [options] <path> [outputPath]

  • Locally usage

    1. Add module to scripts in your package.json and run compress command npm run compress.
      "scripts"{
        "gzipper": "gzipper",
        "compress": "gzipper compress ./dist"
      }
    1. Use npx command.
      "scripts"{
        "compress": "npx gzipper compress ./dist"
      }
  • UI build tools (e.g. Angular CLI)

  "scripts"{
    "build": "ng build && gzipper compress ./dist"
  }
  • Compress files to a certain directory ./gzipped (folders structure inside dist will be saved)
  "scripts"{
    "build": "ng build && gzipper compress ./dist ./gzipped"
  }
  • Compress files to very deep folder ./very/deep/folder (all folders will be automatically created if not exist)
  "scripts"{
    "build": "ng build && gzipper compress ./dist ./very/deep/folder"
  }
  • Compress a single file
  "scripts"{
    "build": "ng build && gzipper compress ./dist/awesomeness.txt"
  }

Node.js Module

const { Compress } = require('gzipper');
const gzip = new Compress('./test', './dist', { verbose: true });
 
try {
  const files = await compress.run();
  console.info('Compressed files: ', files);
} catch (err) {
  console.error(err);
}
  • Run multiple algorithms at the same time.
const { Compress } = require('gzipper');
const gzip = new Compress('./test');
const brotli = new Compress('./test', null, { brotli: true });
 
try {
  const [gzipFiles, brotliFiles] = await Promise.all([
    gzip.compress(),
    brotli.compress(),
  ]);
  console.info('Compressed gzip files: ', gzipFiles);
  console.info('Compressed brotli files: ', brotliFiles);
} catch (err) {
  console.error(err);
}

Options

Compress|c

Option ENV
--incremental (beta) GZIPPER_INCREMENTAL (0 or 1)
-v, --verbose GZIPPER_VERBOSE (0 or 1)
-e, --exclude <extensions> GZIPPER_EXCLUDE
-i, --include <extensions> GZIPPER_INCLUDE
-t, --threshold <number> GZIPPER_THRESHOLD
--level <number> GZIPPER_LEVEL
--memory-level <number> GZIPPER_MEMORY_LEVEL
--strategy <number> GZIPPER_STRATEGY
--deflate GZIPPER_DEFLATE (0 or 1)
--brotli GZIPPER_BROTLI (0 or 1)
--brotli-param-mode <value> GZIPPER_BROTLI_PARAM_MODE
--brotli-quality <number> GZIPPER_BROTLI_QUALITY
--brotli-size-hint <number> GZIPPER_BROTLI_SIZE_HINT
--output-file-format <value> GZIPPER_OUTPUT_FILE_FORMAT
--remove-larger GZIPPER_REMOVE_LARGER

ENV Variables have higher priority over CLI arguments.

--incremental

gzipper c --incremental ./dist

A special type of compression that significantly decreases the time of compression (on the second run) if you have a lot of big and rarely updated files. It creates a .gzipper folder with pre-compressed files (cache) and config that store all necessary metadata (.gzipperconfig).

-v, --verbose

gzipper c --verbose ./dist

Get more information about executed work. (Could increase time of compression because of gathering additional metrics)

-e, --exclude

gzipper c --exclude jpeg,png,ico ./dist

Exclude file extensions from compression, example: jpeg,jpg...

-i, --include

gzipper c --include jpeg,png,ico ./dist

Include file extensions for compression(exclude others), example: js,css,html...

-t, --threshold

gzipper c --threshold 900 ./dist

Exclude assets smaller than this byte size. 0 (default)

--level

gzipper c --level 8 ./dist

Compression level 6 (default), 0 (no compression) - 9 (best compression)

--memory-level

gzipper c --memory-level 2 ./dist

Amount of memory which will be allocated for compression 8 (default), 1 (minimum memory) - 9 (maximum memory)

--strategy

gzipper c --strategy 3 ./dist

Compression strategy 0 (default), 1 (filtered), 2 (huffman only), 3 (RLE), 4 (fixed)

--deflate

gzipper c --deflate ./dist

Enable deflate compression.

--brotli

gzipper c --brotli ./dist

Enable brotli compression, Node.js >= v11.7.0.

--brotli-param-mode

gzipper c --brotli-param-mode text ./dist

Available values are default, text (for UTF-8 text), font (for WOFF 2.0 fonts), only for --brotli

--brotli-quality

gzipper c --brotli-quality 10 ./dist

Brotli compression quality 11 (default), 0 - 11, only for --brotli

--brotli-size-hint

gzipper c --brotli-size-hint 6 ./dist

Expected input size 0 (default), only for --brotli

--output-file-format

Output file format with artifacts, default format: [filename].[ext].[compressExt]. Where: filename -> name of your file, ext -> file extension, compressExt -> compress extension (.gz, .br, etc), hash -> uniq hash.

Example: Expected project structure.

img
  rabbit.jpg
  cat.jpg
js
  main.js
  modules.js
xml
  main.xml
index.js
  • gzipper c --output-file-format [filename].[compressExt].[ext] ./dist
img
  rabbit.gz.jpg
  cat.gz.jpg
js
  main.gz.js
  modules.gz.js
xml
  main.gz.xml
index.gz.js
  • gzipper c --output-file-format test-[filename]-[hash].[compressExt].[ext] ./dist
img
  test-rabbit-b4564011-ba7c-4bd6-834d-bf6c7791b7d4.gz.jpg
  test-cat-739c7d7d-53ca-4f8e-912c-bad3b2b515a9.gz.jpg
js
  test-main-4cc35dbd-36f7-4889-9f41-4d93e7a25bef.gz.js
  test-modules-bce90cbd-5bf2-43c2-8b61-33aa1599b704.gz.js
xml
  test-main-a90fa10e-f7a4-4af9-af67-f887bb96f98b.gz.xml
test-index-067c1e2d-0e12-4b57-980b-97c880c24d57.gz.js
  • gzipper c --output-file-format [filename]-[hash]-[filename]-tmp.[ext].[compressExt] ./dist
img
  rabbit-b4564011-ba7c-4bd6-834d-bf6c7791b7d4-rabbit-tmp.jpg.gz
  cat-739c7d7d-53ca-4f8e-912c-bad3b2b515a9cat-tmp.jpg.gz
js
  main-4cc35dbd-36f7-4889-9f41-4d93e7a25bef-main-tmp.js.gz
  modules-bce90cbd-5bf2-43c2-8b61-33aa1599b704-modules-tmp.js.gz
xml
  main-a90fa10e-f7a4-4af9-af67-f887bb96f98b-main-tmp.xml.gz
index-067c1e2d-0e12-4b57-980b-97c880c24d57-index-tmp.js.gz

--remove-larger

Removes compressed files that larger than uncompressed originals in your directory.

Cache

Command
purge
size

purge

gzipper cache purge

Removes all pre-compressed files from cache which was generated via --incremental flag.

size

gzipper cache size

Returns the size of all pre-compiled files from cache.

Changelog

CHANGELOG.md

Contribution

I appreciate every contribution, just fork the repository and send the pull request with your changes.

Support

  • Node.js >= 10

Install

npm i gzipper

DownloadsWeekly Downloads

13,951

Version

4.3.0

License

GPL-3.0

Unpacked Size

182 kB

Total Files

36

Last publish

Collaborators

  • avatar