Clean comments in filetools.js

Author: Lucas Rojas

lib/fileTools.js

@@ -77,8 +77,6 @@ function copyFolder (source, target, options, callback) {
   }
 
   return Q.nfcall(ncp, source, target, options || {}).catch(function (err) {
-    // flatten errors, otherwise it breaks things downstream
-    // see https://github.com/AvianFlu/ncp/issues/52
     if (Array.isArray(err)) {
       var msg = err.reduce(function (previous, current) {
         return previous += (previous.length ? '\n' : '') + current.message;
@@ -101,11 +99,9 @@ function replaceFileContent (source, replacementFunc, callback) {
 }
 
 function mkdirp (filePath, callback) {
-  // ensure filePath points to a valid drive
   var fullPath = path.resolve(filePath);
   var rootPath = path.parse(fullPath).root;
 
-  // create directory recursively
   return stat(rootPath).then(function () {
     return Q.nfcall(_mkdirp, filePath);
   })
@@ -154,40 +150,30 @@ function searchFile (dir, fileName, callback) {
   });
 }
 
-// Copies the 'source' file to 'target' if it's missing after creating the
-// required directory structure.
 function syncFile (source, target, callback) {
 
-  // check target file
   return stat(target).then(function (info) {
-    // verify that target is a file and not a directory
     if (info.isDirectory()) {
       return Q.reject(new Error('Cannot synchronize file \'' + source + '\'. There is already a directory in the target with the same name.'));
     }
 
-    // skip target if it already exists
     return;
   })
   .catch(function (err) {
-    // return failure for anything other than 'not found'
     if (err.code !== 'ENOENT') {
       return Q.reject(err);
     }
 
-    // copy source to target
     var targetDir = path.dirname(target);
     return stat(targetDir).catch(function (err) {
-      // return failure for anything other than 'not found'
       if (err.code !== 'ENOENT') {
         return Q.reject(err);
       }
 
-      // create target directory
       return mkdirp(targetDir).then(function () {
         log.debug('Created target directory at \'' + targetDir + '\'.');
       })
       .catch(function (err) {
-        // ignore error if target was already created by a different "thread"
         if (err.code !== 'EEXIST') {
           return Q.reject(err);
         }
@@ -221,37 +207,30 @@ function syncFiles (source, target, options, callback) {
     options = {};
   }
 
-  // read the contents of the source directory
   return Q.nfcall(fs.readdir, source).then(function (files) {
 
-    // process each file and folder
     var tasks = files.map(function (fileOrDir) {
       var sourceFile = path.join(source, fileOrDir);
       return stat(sourceFile).then(function (info) {
 
-        // if fileOrDir is a directory, synchronize it
         if (info.isDirectory()) {
           return syncFiles(sourceFile, path.join(target, fileOrDir), options);
         }
 
-        // check to see if file should be skipped
         if (options.filter) {
           var check = options.filter(fileOrDir);
           if (check === false) {
             return;
           }
         }
 
-        // synchronize a single file
         var targetFile = path.join(target, fileOrDir);
         return syncFile(sourceFile, targetFile);
       });
     });
 
-    // wait for all pending tasks to complete
     return Q.all(tasks).then(function (values) {
 
-      // build a list of the files that were copied
       return values.reduce(function (list, value) {
         if (value) {
           if (Array.isArray(value)) {
@@ -271,17 +250,13 @@ function syncFiles (source, target, options, callback) {
       return Q.reject(err);
     }
 
-    // specified source is a file not a directory
     var sourceFile = path.basename(source);
     var targetFile = path.basename(target);
 
-    // build target file path assuming target is a directory
-    // unless target already includes the file name
     if (sourceFile !== targetFile) {
       target = path.join(target, sourceFile);
     }
 
-    // synchronize the file
     return syncFile(source, target).then(function (file) {
       return file ? [file] : [];
     });