Refactors the main module. Adds unit testing. Fixes #2

Author: mihai-vlc

.gitignore

@@ -1,2 +1,4 @@
 node_modules
-tmp
+coverage
+.nyc_output
+tmp

.jsfmtrc

@@ -0,0 +1,3 @@
+test
+coverage
+.nyc_output

.npmignore

@@ -0,0 +1,4 @@
+language: node_js
+node_js:
+  - '6'
+  - '4'

.travis.yml

@@ -1,5 +1,7 @@
 # uglifyjs-folder
 
+[![Build Status](https://travis-ci.org/ionutvmi/uglifyjs-folder.svg?branch=master)](https://travis-ci.org/ionutvmi/uglifyjs-folder)
+
 Command to run uglifyjs on a folder and minify the result in a single file or a new folder.
 
 ## Getting Started

README.md

@@ -7,81 +7,76 @@ var extend = require('extend');
 var fs = require('fs');
 var mkdirp = require('mkdirp');
 
-var _default = {
+var defaultOptions = {
   comments: true,
   output: '',
-  each: false
+  each: false,
+  extension: '.min.js'
 };
 
-module.exports = function(dirPath, options) {
-  var res = '';
-  var opt = extend({}, _default, options);
+module.exports = function (dirPath, options) {
+  options = extend({}, defaultOptions, options);
 
   // grab and minify all the js files
   var files = readDir.readSync(dirPath, ['**.js']);
 
-  files.forEach(function(v, i) {
-    var code, newName;
+  if (options.each) {
+    // minify each file individually
+    files.forEach(function (fileName) {
+      options.output = isEmpty(options.output) ? '_out_' : options.output;
+      var newName = path.join(options.output, path.dirname(fileName), path.basename(fileName, path.extname(fileName))) + options.extension;
 
-    // minify each file in the new folder
-    if (opt.each) {
-      code = uglifyJS.minify(path.join(dirPath, v)).code;
+      var code = uglifyJS.minify(path.join(dirPath, fileName)).code;
+      writeFile(newName, code);
+    });
 
-      // build the new path
-      if ( ! isValidOutput(opt.output)) {
-        opt.output = '_out_';
-      }
-      newName = path.join(opt.output, path.dirname(v), path.basename(v, path.extname(v))) + opt.extension;
+  } else {
 
-      mkdirp.sync(path.dirname(newName));
+    var result = '';
+    // concatenate all the files into one
+    files.forEach(function (fileName) {
+      if (options.comments) {
+        result += '/**** ' + fileName + ' ****/\n';
+      }
 
-      fs.writeFile(newName, code, function(err) {
-        if (err) {
-          console.log('Error: ' + err);
-          return;
-        }
-        console.log('File ' + newName + ' written successfully !');
-      });
+      result += uglifyJS.minify(path.join(dirPath, fileName)).code + '\n';
+    });
 
+    if (isEmpty(options.output)) {
+      return result;
     } else {
-      // concatenate all the files into one
-      if (opt.comments) {
-        res += '/**** ' + v + ' ****/\n';
-      }
-
-      res += uglifyJS.minify(path.join(dirPath, v)).code + '\n';
+      writeFile(options.output, result);
     }
 
-  });
-
-  // return or write the content in the output file
-  if (opt.output) {
+  }
 
-    if (!opt.each) {
+};
 
-      if ( ! isValidOutput(opt.output)) {
-        opt.output = '_out_.js';
-      }
-      fs.writeFile(opt.output, res, function(err) {
-        if (err) {
-          console.log('Error: ' + err);
-          return;
-        }
-        console.log('File ' + opt.output + ' written successfully !');
-      });
-    }
+/**
+ * Checks if the provided parameter is not an empty string.
+ */
+function isEmpty(str) {
+  if (typeof str != 'string' || str.trim() == '') {
+    return true;
+  }
+  return false;
+}
 
-  } else {
+/**
+ * Writes the code at the specified path.
+ */
+function writeFile(filePath, code) {
 
-    return res;
-  }
+  mkdirp(path.dirname(filePath), function () {
 
+    fs.writeFile(filePath, code, function (err) {
+      if (err) {
+        console.log('Error: ' + err);
+        return;
+      }
+      console.log('File ' + filePath + ' written successfully !');
+    });
+  });
 
-  function isValidOutput(str) {
-    if (typeof opt.output != 'string' || opt.output.trim() == '') {
-      return false;
-    }
-    return true;
-  }
+}
 
-};

index.js

@@ -1,7 +1,7 @@
 {
   "name": "uglifyjs-folder",
   "description": "Run uglifyjs on a folder and minify the result in a single file",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "homepage": "https://github.com/ionutvmi/uglifyjs-folder",
   "author": {
     "name": "Mihai Ionut Vilcu",
@@ -29,15 +29,30 @@
     "directory",
     "cli"
   ],
-  "preferGlobal": "true",
+  "preferGlobal": true,
   "bin": {
     "uglifyjs-folder": "cli.js"
   },
+  "scripts": {
+    "test": "ava",
+    "coverage": "nyc --reporter=lcov ava"
+  },
+  "ava": {
+    "files": [
+      "test/index.js"
+    ]
+  },
   "dependencies": {
-    "extend": "^3.0.0",
-    "meow": "^3.7.0",
-    "mkdirp": "^0.5.1",
+    "extend": "3.0.0",
+    "meow": "3.7.0",
+    "mkdirp": "0.5.1",
     "readdir": "0.0.13",
-    "uglify-js": "^2.7.3"
+    "uglify-js": "2.7.5"
+  },
+  "devDependencies": {
+    "ava": "0.17.0",
+    "nyc": "^10.0.0",
+    "proxyquire": "^1.7.10",
+    "sinon": "^1.17.6"
   }
 }

package.json

@@ -0,0 +1 @@
+

test/fixtures/folder1/file1.js

@@ -0,0 +1,179 @@
+import test from 'ava';
+import proxyquire from 'proxyquire';
+import sinon from 'sinon';
+import path from 'path';
+
+var customStubs = {
+  mkdirpStub: function() {}
+};
+
+var requireStub = {
+  fs: {
+    writeFile: function() {}
+  },
+  mkdirp: function() {
+    return customStubs.mkdirpStub.apply(this, arguments);
+  },
+  'uglify-js': {
+    minify: function() {}
+  }
+};
+
+var uglifyJsFolder = proxyquire('../index', requireStub);
+var sandbox;
+
+test.beforeEach(() => {
+   sandbox = sinon.sandbox.create();
+});
+
+test.afterEach(() => {
+   sandbox.restore();
+});
+
+test('exports a functions', t => {
+  t.is(typeof uglifyJsFolder, 'function');
+
+});
+
+test('calls minify for all the files', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  uglifyJsFolder(__dirname + '/fixtures/folder1');
+
+  t.deepEqual(requireStub['uglify-js'].minify.callCount, 2);
+});
+
+test('calls minify for all nested files', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  uglifyJsFolder(__dirname + '/fixtures/folder2');
+
+  t.deepEqual(requireStub['uglify-js'].minify.callCount, 2);
+});
+
+test('comments are present when minifying in a single file', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  var result = uglifyJsFolder(__dirname + '/fixtures/folder1');
+
+  t.true(result.indexOf('/**** file1.js ****/') > -1);
+  t.true(result.indexOf('/**** file2.js ****/') > -1);
+});
+
+test('skip comments if disabled', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  var result = uglifyJsFolder(__dirname + '/fixtures/folder1', {
+    comments: false
+  });
+
+  t.true(result.indexOf('/**** file1.js ****/') == -1);
+  t.true(result.indexOf('/**** file2.js ****/') == -1);
+});
+
+test('write file if the output parameter is present', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  sandbox.stub(customStubs, 'mkdirpStub').callsArg(1);
+  sandbox.stub(requireStub.fs, 'writeFile');
+
+  var result = uglifyJsFolder(__dirname + '/fixtures/folder1', {
+    output: 'subfolder/scripts.min.js'
+  });
+
+  t.true(customStubs.mkdirpStub.calledOnce);
+  t.true(customStubs.mkdirpStub.calledWith('subfolder'));
+  t.true(requireStub.fs.writeFile.calledWith('subfolder/scripts.min.js'));
+});
+
+test('write files in the specified output folder', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  sandbox.stub(customStubs, 'mkdirpStub').callsArg(1);
+  sandbox.stub(requireStub.fs, 'writeFile');
+
+  var dirPath = __dirname + '/fixtures/folder1';
+  var outputPath = 'folder/dist';
+
+  var result = uglifyJsFolder(dirPath, {
+    output: outputPath,
+    each: true
+  });
+
+  t.deepEqual(customStubs.mkdirpStub.callCount, 2);
+  t.deepEqual(path.relative(requireStub.fs.writeFile.args[0][0], outputPath + '/file1.min.js'), '');
+  t.deepEqual(path.relative(requireStub.fs.writeFile.args[1][0], outputPath + '/file2.min.js'), '');
+});
+
+test('maintain subfolder structure', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  sandbox.stub(customStubs, 'mkdirpStub').callsArg(1);
+  sandbox.stub(requireStub.fs, 'writeFile');
+
+  var dirPath = __dirname + '/fixtures/folder2';
+  var outputPath = 'folder/dist';
+
+  var result = uglifyJsFolder(dirPath, {
+    output: outputPath,
+    each: true
+  });
+
+  t.deepEqual(customStubs.mkdirpStub.callCount, 2);
+  t.deepEqual(path.relative(requireStub.fs.writeFile.args[0][0], outputPath + '/file1.min.js'), '');
+  t.deepEqual(path.relative(requireStub.fs.writeFile.args[1][0], outputPath + '/folder2-nested/file2.min.js'), '');
+});
+
+test('_out_ used as default output folder', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  sandbox.stub(customStubs, 'mkdirpStub').callsArg(1);
+  sandbox.stub(requireStub.fs, 'writeFile');
+
+  var dirPath = __dirname + '/fixtures/folder2';
+
+  var result = uglifyJsFolder(dirPath, {
+    each: true
+  });
+
+  t.deepEqual(customStubs.mkdirpStub.callCount, 2);
+  t.deepEqual(path.relative(requireStub.fs.writeFile.args[0][0], '_out_/file1.min.js'), '');
+  t.deepEqual(path.relative(requireStub.fs.writeFile.args[1][0], '_out_/folder2-nested/file2.min.js'), '');
+});
+
+test('uses custom extension', t => {
+  sandbox.stub(requireStub['uglify-js'], 'minify').returns({
+    code: ''
+  });
+
+  sandbox.stub(customStubs, 'mkdirpStub').callsArg(1);
+  sandbox.stub(requireStub.fs, 'writeFile');
+
+  var dirPath = __dirname + '/fixtures/folder2';
+
+  var result = uglifyJsFolder(dirPath, {
+    each: true,
+    extension: '.test.txx'
+  });
+
+  t.deepEqual(customStubs.mkdirpStub.callCount, 2);
+  t.deepEqual(path.relative(requireStub.fs.writeFile.args[0][0], '_out_/file1.test.txx'), '');
+  t.deepEqual(path.relative(requireStub.fs.writeFile.args[1][0], '_out_/folder2-nested/file2.test.txx'), '');
+});
+