feat(shrinkpack): decompress by default, provide --compress option

closes #40

cli.js

@@ -16,20 +16,19 @@ var directoryValue;
 
 program
   .version(version)
+  .option('-c, --compress', 'use compressed .tgz tarballs instead of .tar')
   .arguments('[directory]')
   .action(function (directory) {
-    directoryValue = directory;
+    directoryValue = directory ? path.resolve(directory) : process.cwd();
   });
 
 program.on('--help', onHelp);
-
 program.parse(process.argv);
 
-if (directoryValue) {
-  cli.run(path.resolve(directoryValue));
-} else {
-  cli.run(process.cwd());
-}
+cli.run({
+  compress: program.compress === true,
+  directory: directoryValue
+});
 
 function onHelp() {
   console.log('  Icons:');
@@ -42,6 +41,13 @@ function onHelp() {
   logIcon(chalk.green, '✓', 'Resolved');
   logIcon(chalk.grey, '12:34', 'Time Taken');
   console.log('');
+  console.log('  Compression:');
+  console.log('');
+  console.log('    Although compressed .tgz files have lower filesizes, storing binary files in');
+  console.log('    Git can result in a gradual increase in the time it takes to push to your');
+  console.log('    repository. Shrinkpack uses uncompressed, plain text .tar files by default,');
+  console.log('    which are handled optimally by Git in the same way that .md, .js, and .css');
+  console.log('    files are for example.');
 
   function logIcon(colour, icon, label) {
     console.log('    ' + colour(icon) + ' ' + label);

package.json

@@ -33,9 +33,7 @@
   "dependencies": {
     "chalk": "1.1.3",
     "commander": "2.9.0",
-    "glob": "7.0.5",
     "graceful-fs": "4.1.5",
-    "lodash.uniq": "4.4.0",
     "when": "3.7.7"
   },
   "devDependencies": {

src/analyse/dependency/index.js

@@ -29,7 +29,7 @@ Dependency.prototype = {
   bundle: function () {
     if (!this.isBundled()) {
       return bundle(this).then(function (dependency) {
-        console.info(chalk.green('+ %s'), dependency.getId());
+        console.info(chalk.green('+ %s'), dependency.getBundleName());
         return dependency;
       });
     }
@@ -45,14 +45,18 @@ Dependency.prototype = {
     return when(this);
   },
   config: null,
+  getBundleName: function () {
+    var extension = this.config.options.compress ? '.tgz' : '.tar';
+    var name = this.name.replace(/\//g, '-');
+    var version = this.graph.version;
+    return name + '-' + version + extension;
+  },
   getId: function () {
     return this.name + '@' + this.graph.version;
   },
   getPathToBundle: function () {
     var directory = this.config.path.shrinkpack;
-    var name = this.name.replace(/\//g, '-');
-    var version = this.graph.version;
-    return path.join(directory, name + '-' + version + '.tgz');
+    return path.join(directory, this.getBundleName());
   },
   getPathToNpmCache: function () {
     return path.join(this.config.path.npmCache, this.name, this.graph.version, 'package.tgz');

src/analyse/index.js

@@ -16,8 +16,8 @@ var readNpmCache = require('./read-npm-cache');
 module.exports = init;
 
 // implementation
-function init(directory) {
-  return when({startTime: new Date()})
+function init(options) {
+  return when({options: options, startTime: new Date()})
     .then(getConfigWithPaths)
     .then(getConfigWithGraph)
     .then(ensureBundleExists)
@@ -28,7 +28,7 @@ function init(directory) {
     .then(getConfigWithStats);
 
   function getConfigWithPaths(config) {
-    return getPaths(directory)
+    return getPaths(config.options.directory)
       .then(function (paths) {
         return assign(config, {path: paths});
       });

src/cli/index.js

@@ -10,8 +10,8 @@ module.exports = {
 };
 
 // implementation
-function runCli(directory) {
-  return analyse(directory)
+function runCli(options) {
+  return analyse(options)
     .then(update, onFail)
     .then(displaySummary, onFail)
     .catch(onFail);

src/lib/copy-file.js

@@ -1,20 +1,29 @@
+// node modules
+var zlib = require('zlib');
+
 // 3rd party modules
 var chalk = require('chalk');
 var fs = require('graceful-fs');
+var when = require('when');
 
 // public
 module.exports = copyFile;
 
 // implementation
 function copyFile(source, target) {
-  return new Promise(function (resolve, reject) {
+  return when.promise(function (resolve, reject) {
     var read$ = fs.createReadStream(source);
     var write$ = fs.createWriteStream(target);
 
     read$.on('error', onReadError);
     write$.on('error', onWriteError);
     write$.on('finish', onWriteEnd);
-    read$.pipe(write$);
+
+    if (isCompressed()) {
+      read$.pipe(write$);
+    } else {
+      read$.pipe(zlib.createGunzip()).pipe(write$);
+    }
 
     function onReadError(err) {
       console.error(chalk.red('! failed to read file %s'), source);
@@ -29,5 +38,9 @@ function copyFile(source, target) {
     function onWriteEnd() {
       resolve();
     }
+
+    function isCompressed() {
+      return target.search(/\.tar$/) === -1;
+    }
   });
 }