Add zopfli

Author: monochromer

README.md

@@ -48,6 +48,7 @@ compress({
 | `--from` (alias `--input`) | `from` (alias `input`) | Input folder | `process.cwd()` |
 | `--to` (alias `--output`) | `to` (alias `output`) | Output folder | `from` param value |
 | `--formats` | `formats` | Formats of output files | `['gzip', 'brotli']`|
+| `--with-zopfli` | `withZopfli` | Enable zopfli algorithm for gzip | `false` |
 | `--ext-white-list` | `extWhiteList` | A list of extensions that will be used to filter the necessary files | `['.html', '.css', '.js', '.json', '.svg', '.txt', '.xml']` |
 | `--concurrency` | `concurrency` | number of parallel handlers | `os.cpus().length` |
 | `--file-size` | `fileSize` | File size treshold in bytes. Files smaller than this size will be ignored | `0` |

cli.js

@@ -63,7 +63,8 @@ compress({
   formats,
   extWhiteList: params['ext-white-list'],
   concurrency: params['concurrency'],
-  fileSize: params['file-size']
+  fileSize: params['file-size'],
+  withZopfli: params['with-zopfli']
 })
   .then(() => {
     const diffTime = Math.round(performance.now() - startTime);

lib/constants.js

@@ -8,20 +8,31 @@ const FORMATS = {
 
 exports.FORMATS = FORMATS;
 
-exports.DEFAULT_COMPRESS_SETTINGS = {
-  [FORMATS.GZIP]: {
-    level: zlib.constants.Z_BEST_COMPRESSION
-  },
-  [FORMATS.BROTLI]: {
-    params: {
-      [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,
-      [zlib.constants.BROTLI_PARAM_QUALITY]: zlib.constants.BROTLI_MAX_QUALITY
-    }
-  },
-  [FORMATS.ZSTD]: {
-    params: {
-      [zlib.constants.ZSTD_c_compressionLevel]: 22,
-      [zlib.constants.ZSTD_c_checksumFlag]: 1,
+exports.DEFAULT_COMPRESS_SETTINGS = (params) => {
+  const { withZopfli = false } = params;
+  return {
+    [FORMATS.GZIP]: withZopfli
+      ? {
+        verbose: false,
+        verbose_more: false,
+        numiterations: 15,
+        blocksplitting: true,
+        blocksplittingmax: 15,
+      }
+      : {
+        level: zlib.constants.Z_BEST_COMPRESSION
+      },
+    [FORMATS.BROTLI]: {
+      params: {
+        [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,
+        [zlib.constants.BROTLI_PARAM_QUALITY]: zlib.constants.BROTLI_MAX_QUALITY
+      }
+    },
+    [FORMATS.ZSTD]: {
+      params: {
+        [zlib.constants.ZSTD_c_compressionLevel]: 22,
+        [zlib.constants.ZSTD_c_checksumFlag]: 1,
+      }
     }
   }
 }

lib/functions.js

@@ -1,9 +1,10 @@
 const os = require('os');
 const fs = require('fs');
-const fsp = require('fs/promises');
 const path = require('path');
-const { pipeline } = require('stream/promises');
+const stream = require('stream');
 const zlib = require('zlib');
+const { Buffer } = require('buffer')
+const { gzipAsync } = require('@gfx/zopfli');
 
 const CONSTANTS = require('./constants');
 const { walk, makeDir } = require('./fs-utils');
@@ -16,20 +17,37 @@ const {
   flatMap
 } = require('./generators-utils');
 
-
-const FORMAT_TO_STREAM = {
-  [CONSTANTS.FORMATS.GZIP]: zlib.createGzip,
-  [CONSTANTS.FORMATS.BROTLI]: zlib.createBrotliCompress,
-  [CONSTANTS.FORMATS.ZSTD]: zlib.createZstdCompress || (() => {
-    throw new Error(`Your version of Node.js doesn't support zstd. Node.js has zstd support since 23.8.0 and 22.15.0.`)
-  })
+const FORMAT_TO_STREAM = (params) => {
+  const { withZopfli = false } = params;
+  return {
+    [CONSTANTS.FORMATS.GZIP]:
+      withZopfli
+        ? (
+          function createZopfli(options) {
+            return stream.Duplex.from(async function* (source) {
+              const chunks = [];
+              for await (const chunk of source) {
+                chunks.push(chunk);
+              }
+              yield await gzipAsync(Buffer.concat(chunks), options);
+            })
+          }
+        )
+        : zlib.createGzip,
+    [CONSTANTS.FORMATS.BROTLI]: zlib.createBrotliCompress,
+    [CONSTANTS.FORMATS.ZSTD]: zlib.createZstdCompress || (() => {
+      throw new Error(`Your version of Node.js doesn't support zstd. Node.js has zstd support since 23.8.0 and 22.15.0.`)
+    })
+  }
 }
 
 
-function createCompressStream({ fromPath, toPath, format, compressOptions }) {
-  return pipeline(
+function createCompressStream({ fromPath, toPath, format, compressOptions, withZopfli }) {
+  const params = { withZopfli }
+
+  return stream.promises.pipeline(
     fs.createReadStream(fromPath),
-    FORMAT_TO_STREAM[format](compressOptions || CONSTANTS.DEFAULT_COMPRESS_SETTINGS[format]),
+    FORMAT_TO_STREAM(params)[format](compressOptions || CONSTANTS.DEFAULT_COMPRESS_SETTINGS[format]),
     fs.createWriteStream(toPath + CONSTANTS.FORMAT_TO_EXT[format])
   );
 }
@@ -51,14 +69,15 @@ async function compress(params) {
     formats = [CONSTANTS.FORMATS.GZIP],
     extWhiteList = CONSTANTS.EXT_WHITE_LIST,
     concurrency = getConcurrency(),
-    fileSize
+    fileSize,
+    withZopfli = false
   } = params;
 
   const handlers = [
     filter(item => item.dirent.isFile()),
     filter(item => extWhiteList.includes(path.extname(item.direntPath))),
     fileSize && map(async item => {
-      const stat = await fsp.stat(item.direntPath);
+      const stat = await fs.promises.stat(item.direntPath);
       return {
         ...item,
         size: stat.size
@@ -83,7 +102,7 @@ async function compress(params) {
 
         await makeDir(toBasePath);
 
-        return createCompressStream({ fromPath, toPath, format: item.format });
+        return createCompressStream({ fromPath, toPath, format: item.format, withZopfli });
       }
     }),
   ].filter(Boolean);

package-lock.json

@@ -34,5 +34,8 @@
     "zstandard",
     "archive",
     "CLI"
-  ]
+  ],
+  "dependencies": {
+    "@gfx/zopfli": "^1.0.15"
+  }
 }