decompress - npm Package Compare versions

Comparing version 1.0.7 to 2.0.0

cli.js

@@ -69,2 +69,6 @@ #!/usr/bin/env node
 function isFile(path) {
+    if (/^[^\s]+\.\w*$/g.test(path)) {
+        return true;
+    }
+
     try {
@@ -80,12 +84,11 @@ return fs.statSync(path).isFile();
  *
- * @param {String} input
- * @param {String} output
- * @param {Object} opts
+ * @param {String} src
+ * @param {String} dest
  * @api private
  */
 
-function run(input, output, opts) {
+function run(src, dest) {
     var decompress = new Decompress(opts)
-        .src(input)
-        .dest(output)
+        .src(src)
+        .dest(dest)
         .use(Decompress.tar(opts))
@@ -95,3 +98,3 @@ .use(Decompress.targz(opts))
 
-    decompress.decompress(function (err) {
+    decompress.run(function (err) {
         if (err) {
@@ -108,6 +111,6 @@ console.error(err);
 
-var input = opts.argv.remain;
-var output = process.cwd();
+var src = opts.argv.remain;
+var dest = process.cwd();
 
-if (input.length === 0) {
+if (!src.length) {
     help();
@@ -117,7 +120,7 @@ return;
 
-if (input.length > 1 && !isFile(input[input.length - 1])) {
-    output = input[input.length - 1];
-    input.pop();
+if (!isFile(src[src.length - 1])) {
+    dest = src[src.length - 1];
+    src.pop();
 }
 
-run(input.join(), output, opts);
+run(src, dest);

index.js

 'use strict';
 
-var each = require('each-async');
-var fs = require('fs-extra');
-var path = require('path');
-var Ware = require('ware');
+var combine = require('stream-combiner');
+var concat = require('concat-stream');
+var File = require('vinyl');
+var fs = require('vinyl-fs');
+var through = require('through2');
 
@@ -22,24 +23,12 @@ /**
     this.opts.mode = parseInt(this.opts.mode, 8) || null;
-    this.ware = new Ware();
+    this.streams = [];
 }
 
 /**
- * Add a plugin to the middleware stack
+ * Get or set the source files
  *
- * @param {Function} plugin
+ * @param {Array|Buffer|String} file
  * @api public
  */
 
-Decompress.prototype.use = function (plugin) {
-    this.ware.use(plugin);
-    return this;
-};
-
-/**
- * Get or set the source file
- *
- * @param {String|Buffer} file
- * @api public
- */
-
 Decompress.prototype.src = function (file) {
@@ -55,9 +44,9 @@ if (!arguments.length) {
 /**
- * Get or set the destination path
+ * Get or set the destination folder
  *
- * @param {String} path
+ * @param {String} dir
  * @api public
  */
 
-Decompress.prototype.dest = function (path) {
+Decompress.prototype.dest = function (dir) {
     if (!arguments.length) {
@@ -67,3 +56,3 @@ return this._dest;
 
-    this._dest = path;
+    this._dest = dir;
     return this;
@@ -73,40 +62,16 @@ };
 /**
- * Decompress archive
+ * Add a plugin to the middleware stack
  *
- * @param {Function} cb
+ * @param {Function} plugin
  * @api public
  */
 
-Decompress.prototype.decompress = function (cb) {
-    cb = cb || function () {};
-    var self = this;
-
-    this.read(function (err, file) {
-        if (!file || file.contents.length === 0) {
-            cb();
-            return;
-        }
-
-        if (err) {
-            cb(err);
-            return;
-        }
-
-        self.run(file, function (err) {
-            if (err) {
-                cb(err);
-                return;
-            }
-
-            self.write(self.files, function (err) {
-                cb(err, file);
-            });
-        });
-    });
+Decompress.prototype.use = function (plugin) {
+    this.streams.push(plugin);
+    return this;
 };
 
 /**
- * Run a file through the middleware
+ * Decompress archive
  *
- * @param {Object} file
  * @param {Function} cb
@@ -116,81 +81,44 @@ * @api public
 
-Decompress.prototype.run = function (file, cb) {
-    this.ware.run(file, this, cb);
-};
+Decompress.prototype.run = function (cb) {
+    cb = cb || function () {};
+    this.streams.unshift(this.read(this.src()));
 
-/**
- * Read the archive
- *
- * @param {Function} cb
- * @api public
- */
+    if (this.dest()) {
+        this.streams.push(fs.dest(this.dest(), this.opts));
+    }
 
-Decompress.prototype.read = function (cb) {
-    var file = {};
-    var src = this.src();
+    var pipe = combine(this.streams);
+    var end = concat(function (file) {
+        cb(null, file);
+    });
 
-    if (Buffer.isBuffer(src)) {
-        file.contents = src;
-        cb(null, file);
+    pipe.on('error', function (err) {
+        cb(err);
         return;
-    }
+    });
 
-    fs.readFile(src, function (err, buf) {
-        if (err) {
-            cb(err);
-            return;
-        }
-
-        file.contents = buf;
-        file.path = src;
-
-        cb(null, file);
-    });
+    pipe.pipe(end);
 };
 
 /**
- * Write files to destination
+ * Read the source files
  *
- * @param {Array} files
- * @param {Function} cb
- * @api public
+ * @param {Array|Buffer|String} src
+ * @api private
  */
 
-Decompress.prototype.write = function (files, cb) {
-    var dest = this.dest();
-    var mode = this.opts.mode;
+Decompress.prototype.read = function (src) {
+    if (Buffer.isBuffer(src)) {
+        var stream = through.obj(function (file, enc, cb) {
+            cb(null, file);
+        });
 
-    if (!dest || !files) {
-        cb();
-        return;
+        stream.end(new File({
+            contents: src
+        }));
+
+        return stream;
     }
 
-    each(files, function (file, i, done) {
-        fs.outputFile(path.join(dest, file.path), file.contents, function (err) {
-            if (err) {
-                done(err);
-                return;
-            }
-
-            if (mode) {
-                return fs.chmod(path.join(dest, file.path), mode, function (err) {
-                    if (err) {
-                        cb(err);
-                        return;
-                    }
-
-                    done();
-                });
-            }
-
-            done();
-        });
-    }, function (err) {
-        if (err) {
-            cb(err);
-            return;
-        }
-
-        cb();
-    });
+    return fs.src(src);
 };
@@ -197,0 +125,0 @@

package.json

 {
   "name": "decompress",
-  "version": "1.0.7",
+  "version": "2.0.0",
   "description": "Easily extract archives",
@@ -26,22 +26,27 @@ "license": "MIT",
   "keywords": [
+    "bz2",
+    "bzip2",
     "decompress",
     "extract",
     "tar",
+    "tar.bz",
     "tar.gz",
-    "zip"
+    "zip",
+    "unzip"
   ],
   "dependencies": {
-    "decompress-tar": "^1.0.0",
-    "decompress-tarbz2": "^1.0.1",
-    "decompress-targz": "^1.0.0",
-    "decompress-unzip": "^1.0.0",
-    "each-async": "^1.0.0",
-    "fs-extra": "^0.11.0",
+    "concat-stream": "^1.4.6",
+    "decompress-tar": "^2.0.0",
+    "decompress-tarbz2": "^2.0.0",
+    "decompress-targz": "^2.0.0",
+    "decompress-unzip": "^2.0.0",
     "nopt": "^3.0.1",
-    "ware": "^0.3.0"
+    "stream-combiner": "^0.2.1",
+    "through2": "^0.6.1",
+    "vinyl": "^0.4.3",
+    "vinyl-fs": "^0.3.7"
   },
   "devDependencies": {
-    "ava": "0.0.4",
-    "rimraf": "^2.2.8"
+    "ava": "0.0.4"
   }
 }

README.md

@@ -1,2 +0,2 @@
-# decompress [![Build Status](https://travis-ci.org/kevva/decompress.svg?branch=master)](https://travis-ci.org/kevva/decompress)
+# decompress [![Build Status](http://img.shields.io/travis/kevva/decompress.svg?style=flat)](https://travis-ci.org/kevva/decompress)
 
@@ -21,3 +21,3 @@ > Easily extract archives
 
-decompress.decompress(function (err) {
+decompress.run(function (err) {
     if (err) {
@@ -37,5 +37,6 @@ throw err;
 
-### .src(file)
+### .src(files)
 
-Set the file to be extract. Can be a `Buffer` or the path to a file.
+Set the files to be decompress. Takes a buffer, glob string or an array of glob 
+strings as argument.
 
@@ -50,3 +51,3 @@ ### .dest(path)
 
-### .decompress(cb)
+### .run(cb)
 
@@ -69,2 +70,3 @@ Extract your file with the given settings.
 * [tar](#tar) — Extract TAR files.
+* [tar.bz](#tarbz) — Extract TAR.BZ files.
 * [tar.gz](#targz) — Extract TAR.GZ files.
@@ -84,2 +86,13 @@ * [zip](#zip) — Extract ZIP files.
 
+### .tarbz()
+
+Extract TAR.BZ files.
+
+```js
+var Decompress = require('decompress');
+
+var decompress = new Decompress()
+    .use(Decompress.tarbz({ strip: 1 }));
+```
+
 ### .targz()
@@ -129,2 +142,2 @@
 
-MIT © [Kevin Mårtensson](http://kevinmartensson.com)
+MIT © [Kevin Mårtensson](https://github.com/kevva)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

1

decreased by-50%

Number of lines in readme file

138

increased by10.4%

Number of low supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Total package byte prevSize

7535

decreased by-11.82%

Dependency count

10

increased by25%

Lines of code

205

decreased by-22.35%

Dependency changes

• + Addedconcat-stream@^1.4.6

• + Addedstream-combiner@^0.2.1

• + Addedthrough2@^0.6.1

• + Addedvinyl@^0.4.3

• + Addedvinyl-fs@^0.3.7

• + Addedansi-regex@2.1.1(transitive)

• + Addedansi-styles@2.2.1(transitive)

• + Addedbl@0.9.51.2.3(transitive)

• + Addedbuffer-alloc@1.2.0(transitive)

• + Addedbuffer-alloc-unsafe@1.1.0(transitive)

• + Addedbuffer-crc32@0.2.13(transitive)

• + Addedbuffer-fill@1.0.0(transitive)

• + Addedbuffer-from@1.1.2(transitive)

• + Addedchalk@1.1.3(transitive)

• + Addedclone@0.2.01.0.4(transitive)

• + Addedclone-stats@0.0.1(transitive)

• + Addedconcat-stream@1.6.2(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addeddecompress-tar@2.0.2(transitive)

• + Addeddecompress-tarbz2@2.0.2(transitive)

• + Addeddecompress-targz@2.1.0(transitive)

• + Addeddecompress-unzip@2.1.2(transitive)

• + Addeddefaults@1.0.4(transitive)

• + Addedduplexer@0.1.2(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedfd-slicer@1.1.0(transitive)

• + Addedfind-index@0.1.1(transitive)

• + Addedfirst-chunk-stream@1.0.0(transitive)

• + Addedfs-constants@1.0.0(transitive)

• + Addedgaze@0.5.2(transitive)

• + Addedget-stdin@4.0.1(transitive)

• + Addedglob@3.1.214.5.3(transitive)

• + Addedglob-stream@3.1.18(transitive)

• + Addedglob-watcher@0.0.6(transitive)

• + Addedglob2base@0.0.12(transitive)

• + Addedglobule@0.1.0(transitive)

• + Addedgraceful-fs@1.2.33.0.12(transitive)

• + Addedhas-ansi@2.0.0(transitive)

• + Addedinherits@1.0.2(transitive)

• + Addedis-natural-number@2.1.1(transitive)

• + Addedis-utf8@0.2.1(transitive)

• + Addedis-zip@1.0.0(transitive)

• + Addedisarray@0.0.11.0.0(transitive)

• + Addedlodash@1.0.2(transitive)

• + Addedlru-cache@2.7.3(transitive)

• + Addedminimatch@0.2.142.0.10(transitive)

• + Addednatives@1.1.6(transitive)

• + Addedordered-read-streams@0.1.0(transitive)

• + Addedpend@1.2.0(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedreadable-stream@1.0.341.1.142.3.8(transitive)

• + Addedsafe-buffer@5.1.25.2.1(transitive)

• + Addedsigmund@1.0.1(transitive)

• + Addedstream-combiner@0.2.2(transitive)

• + Addedstring_decoder@0.10.311.1.1(transitive)

• + Addedstrip-ansi@3.0.1(transitive)

• + Addedstrip-bom@1.0.0(transitive)

• + Addedstrip-dirs@1.1.1(transitive)

• + Addedsum-up@1.0.3(transitive)

• + Addedsupports-color@2.0.0(transitive)

• + Addedtar-stream@0.4.71.6.2(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedthrough2@0.6.5(transitive)

• + Addedto-buffer@1.1.1(transitive)

• + Addedtypedarray@0.0.6(transitive)

• + Addedunique-stream@1.0.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedvinyl@0.4.6(transitive)

• + Addedvinyl-fs@0.3.14(transitive)

• + Addedxtend@4.0.2(transitive)

• + Addedyauzl@2.10.0(transitive)

• - Removedeach-async@^1.0.0

• - Removedfs-extra@^0.11.0

• - Removedware@^0.3.0

• - Removedadm-zip@0.4.16(transitive)

• - Removedblock-stream@0.0.9(transitive)

• - Removeddecompress-tar@1.0.3(transitive)

• - Removeddecompress-tarbz2@1.0.2(transitive)

• - Removeddecompress-targz@1.0.3(transitive)

• - Removeddecompress-unzip@1.0.0(transitive)

• - Removedeach-async@1.1.1(transitive)

• - Removedfs-extra@0.11.1(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedfstream@1.0.12(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedis-zip@0.1.0(transitive)

• - Removedjsonfile@2.4.0(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removedncp@0.6.0(transitive)

• - Removedonetime@1.1.0(transitive)

• - Removedos-tmpdir@1.0.2(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedrimraf@2.7.1(transitive)

• - Removedset-immediate-shim@1.0.1(transitive)

• - Removedsimple-bufferstream@0.0.4(transitive)

• - Removedtar@1.0.3(transitive)

• - Removedtemp-write@1.1.2(transitive)

• - Removeduuid@2.0.3(transitive)

• - Removedware@0.3.0(transitive)

• Updateddecompress-tar@^2.0.0

• Updateddecompress-tarbz2@^2.0.0

• Updateddecompress-targz@^2.0.0

• Updateddecompress-unzip@^2.0.0