feat: remove pump and raise minimum node to v18 (#113)

BREAKING CHANGE: Drop Node.js < 18 support

Node.js 4 is long EOL, so this PR raises it to 18 as per comment. Node
10 has built-in `stream.pipeline` and `fs.mkdir` with `recursive`
option, which can be used instead of `pump` (they are the same).

Also 3 tests fail for me but they fail on main branch as well (timeout)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Chores**
* Replaced the external stream piping utility with the native Node.js
stream API throughout the codebase and tests.
* Updated documentation examples to reflect the new usage of the native
stream API.
* Replaced external directory creation utilities with native Node.js
directory creation methods using recursive options.
* Removed obsolete dependencies and increased the minimum required
Node.js version to 18.0.0.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: fengmk2 <[email protected]>

Author: talentlessguy

.github/workflows/nodejs.yml

@@ -13,4 +13,4 @@ jobs:
     uses: node-modules/github-actions/.github/workflows/node-test.yml@master
     with:
       os: 'ubuntu-latest, macos-latest, windows-latest'
-      version: '14, 16, 18, 20, 22, 24'
+      version: '18, 20, 22, 24'

README.md

@@ -75,7 +75,7 @@ fs.createReadStream('file/path/to/compress')
   .on('error', handleError);
 
 // You should take care of stream errors in caution, use pump to handle error in one place
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 const sourceStream = fs.createReadStream('file/path/to/compress');
 const gzipStream = new compressing.gzip.FileStream();
 const destStream = fs.createWriteStream('path/to/destination.gz');
@@ -193,7 +193,7 @@ function onEntry(header, stream, next) => {
   if (header.type === 'file') {
     stream.pipe(fs.createWriteStream(path.join(destDir, header.name)));
   } else { // directory
-    mkdirp(path.join(destDir, header.name), err => {
+    fs.mkdir(path.join(destDir, header.name), { recursive: true }, err => {
       if (err) return handleError(err);
       stream.resume();
     });

lib/tgz/file_stream.js

@@ -4,7 +4,7 @@ const tar = require('../tar');
 const gzip = require('../gzip');
 const utils = require('../utils');
 const stream = require('stream');
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 const ready = require('get-ready');
 
 class TgzFileStream extends stream.Transform {

lib/utils.js

@@ -2,8 +2,7 @@
 
 const fs = require('fs');
 const path = require('path');
-const mkdirp = require('mkdirp');
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 
 // file/fileBuffer/stream
 exports.sourceType = source => {
@@ -90,7 +89,7 @@ exports.makeUncompressFn = StreamClass => {
     }
 
     return new Promise((resolve, reject) => {
-      mkdirp(destDir, err => {
+      fs.mkdir(destDir, { recursive: true }, err => {
         if (err) return reject(err);
 
         let entryCount = 0;
@@ -113,7 +112,7 @@ exports.makeUncompressFn = StreamClass => {
 
             if (header.type === 'file') {
               const dir = path.dirname(destFilePath);
-              mkdirp(dir, err => {
+              fs.mkdir(dir, { recursive: true }, err => {
                 if (err) return reject(err);
 
                 entryCount++;
@@ -128,7 +127,7 @@ exports.makeUncompressFn = StreamClass => {
               const target = path.resolve(dir, header.linkname);
               entryCount++;
 
-              mkdirp(dir, err => {
+              fs.mkdir(dir, { recursive: true }, err => {
                 if (err) return reject(err);
 
                 const relativeTarget = path.relative(dir, target);
@@ -139,7 +138,7 @@ exports.makeUncompressFn = StreamClass => {
                 });
               });
             } else { // directory
-              mkdirp(destFilePath, err => {
+              fs.mkdir(destFilePath, { recursive: true }, err => {
                 if (err) return reject(err);
                 stream.resume();
               });

package.json

@@ -39,14 +39,12 @@
   },
   "homepage": "https://github.com/node-modules/compressing#readme",
   "dependencies": {
+    "@eggjs/yauzl": "^2.11.0",
     "flushwritable": "^1.0.0",
     "get-ready": "^1.0.0",
     "iconv-lite": "^0.5.0",
-    "mkdirp": "^0.5.1",
-    "pump": "^3.0.0",
     "streamifier": "^0.1.1",
     "tar-stream": "^1.5.2",
-    "@eggjs/yauzl": "^2.11.0",
     "yazl": "^2.4.2"
   },
   "devDependencies": {
@@ -62,6 +60,6 @@
     "uuid": "^3.0.1"
   },
   "engines": {
-    "node": ">= 4.0.0"
+    "node": ">= 18.0.0"
   }
 }

test/gzip/file_stream.test.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const os = require('os');
 const path = require('path');
 const uuid = require('uuid');
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 const compressing = require('../..');
 const assert = require('assert');
 

test/gzip/uncompress_stream.test.js

@@ -4,7 +4,7 @@ const os = require('os');
 const uuid = require('uuid');
 const path = require('path');
 const assert = require('assert');
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 const streamifier = require('streamifier');
 const compressing = require('../..');
 

test/tar/file_stream.test.js

@@ -6,7 +6,7 @@ const os = require('os');
 const path = require('path');
 const uuid = require('uuid');
 const assert = require('assert');
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 const compressing = require('../..');
 
 describe('test/tar/file_stream.test.js', () => {

test/tar/index.test.js

@@ -8,7 +8,6 @@ const uuid = require('uuid');
 const compressing = require('../..');
 const assert = require('assert');
 const dircompare = require('dir-compare');
-const mkdirp = require('mz-modules/mkdirp');
 
 describe('test/tar/index.test.js', () => {
   afterEach(mm.restore);
@@ -108,7 +107,7 @@ describe('test/tar/index.test.js', () => {
       assert(fs.existsSync(destFile));
 
       const destDir = path.join(os.tmpdir(), uuid.v4());
-      await mkdirp(destDir);
+      await fs.promises.mkdir(destDir, { recursive: true });
       await compressing.tar.uncompress(destFile, destDir);
       const stat = fs.statSync(path.join(destDir, 'bin'));
       assert(stat.mode === originStat.mode);

test/tar/stream.test.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 const os = require('os');
 const path = require('path');
 const uuid = require('uuid');
-const pump = require('pump');
+const { pipeline: pump } = require('stream');
 const compressing = require('../..');
 const assert = require('assert');
 const TarStream = compressing.tar.Stream;