Merge pull request #52 from southworkscom/cleanupCode

Delete unnecessary comments

Author: jgw96

lib/download.js

@@ -13,8 +13,6 @@ function download (inputUri, outputFilePath, callback) {
   var uri = url.parse(inputUri);
 
   if (inputUri.indexOf('http://') !== 0 && inputUri.indexOf('https://') !== 0) {
-    // this is to detect scenarios like localhost:8080 where localhost is
-    // treated as protocol even if it's not.
     if (inputUri.indexOf(uri.protocol + '//') !== 0) {
       inputUri = 'http://' + inputUri;
       uri = url.parse(inputUri);
@@ -55,33 +53,28 @@ function download (inputUri, outputFilePath, callback) {
   var deferred = Q.defer();
   protocol.get(options, function (res) {
 
-    // If Moved Permanently or Found, redirect to new URL
     if ([301, 302].indexOf(res.statusCode) > -1) {
       return download(res.headers.location, outputFilePath)
         .then(function (result) { deferred.resolve(result); })
         .catch(function (err) { deferred.reject(err); });
     }
 
-    // If not OK or Not Modified, throw error
     if ([200, 304].indexOf(res.statusCode) === -1) {
       var err = new Error('Error downloading \'' + inputUri + '\'. Response was \'' + res.statusCode + ' - ' + res.statusMessage + '\'.');
       err.statusCode = res.statusCode;
       err.statusMessage = res.statusMessage;
       return deferred.reject(err);
     }
 
-    // If Not Modified, ignore
     if (res.statusCode === 304) {
       return deferred.resolve({ 'path': outputFilePath, 'statusCode': res.statusCode, 'statusMessage': res.statusMessage, 'contentType': res.headers['content-type'] });
     }
 
-    // Else save
     res.pipe(fs.createWriteStream(outputFilePath))
       .on('close', function () {
         var lastAccessed = new Date();
         var lastModified = res.headers['last-modified'] ? new Date(res.headers['last-modified']) : lastAccessed;
 
-        // update the last modified time of the file to match the response header
         fs.utimes(outputFilePath, lastAccessed, lastModified, function (err) {
           if (err) {
             return deferred.reject(err);

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] : [];
     });

lib/iconTools.js

@@ -17,7 +17,6 @@ function getIcon(iconUrl, iconFilePath, callback) {
 	return fileTools.mkdirp(iconFolder).then(function () {
     return download(iconUrl, iconFilePath).then(function (response) {
       if (response.statusCode === 200 && !response.contentType.match(/image/)) {
-        // If not an image, return an error
         return Q.reject(new Error('Downloaded file  \'' + iconUrl + '\' does not appear to be an image. The content type of the response was \'' + response.contentType + '\'.'));
       }
 
@@ -29,7 +28,6 @@ function getIcon(iconUrl, iconFilePath, callback) {
 
 function copyDefaultIcon(manifest, platformId, iconSize, source, targetPath, callback) {
 
-	// platform already contains an icon with this size - skip
 	if (manifest.icons && manifest.icons[iconSize]) {
 		return Q.resolve().nodeify(callback);
 	}

lib/manifestTools/manifestCreator/scrapers/icojs/src/ico.js

@@ -6,15 +6,12 @@ var imageData = require('./image-data');
 var Q = require('q');
 
 var range = function(n) { 
-  // fill() replaced with for ..
   var array = new Array(n);
   for (var i = 0; i < n; i++) {
     array[i] = 0;
   }
 
   return array.map(function(x, i) { return i; });
-
-  // return new Array(n).fill(0).map(function(_, i) { return i }); 
 };
 
 /**
@@ -159,8 +156,6 @@ var factory = function(config) {
         return false;
       }
       var icoDv = new DataView(buffer);
-      // idReserved = icoDv.getUint16(0, true)
-      // idType = icoDv.getUint16(0, true)
       return icoDv.getUint16(0, true) === 0 && icoDv.getUint16(2, true) === 1;
     },
     /**

lib/manifestTools/manifestLoader.js

@@ -72,8 +72,6 @@ function processManifestContents (data, manifestFormat, callback) {
     detectedFormat = manifestFormat;
   } else if (!detectedFormat) {
       detectedFormat = 'w3c';
-   // var availableFormats = listAvailableManifestFormats().join(', ');
-    //return callback(new Error('Unable to detect the input manifest format. Try specifying the correct format using the -f <format> option. Available formats are: ' + availableFormats + '.'));
   }
 
   log.info('Found a ' + detectedFormat + ' manifest...');

lib/manifestTools/manifestValidator.js

@@ -12,31 +12,24 @@ var constants = require('../constants'),
 
 var toStringFunction = Object.prototype.toString;
 
-// load the rule(s) from a folder or file
 function loadValidationRules(fileOrDir, platforms, callback) {
 
   var stat = Q.nfbind(fs.stat); 
 
-  // list contents of the validation rules folder
   return Q.nfcall(fs.readdir, fileOrDir).then(function (files) {
     return Q.allSettled(files.map(function (file) {
       var filePath = path.join(fileOrDir, file);
       return stat(filePath).then(function (info) {
-        // test if file system object is a directory or a file
         if (info.isDirectory()) {
-          // ignore any directory that doesn't  match one of the requested platforms 
           if (platforms.indexOf(file) < 0) {
               return Q.resolve();
           }
 
-          // process the rules in the platform folder
           return loadValidationRules(filePath, []);
         }
 
-        // load the rules defined in the file
         var rulePath = path.join(fileOrDir, file);
         try {
-          // load the rule from the file
           return require(rulePath);
         }
         catch (err) {
@@ -45,7 +38,6 @@ function loadValidationRules(fileOrDir, platforms, callback) {
       });
     }))
     .then (function (results) {
-      // verify the results and consolidate the loaded rules  
       return results.reduce(function (validationRules, result) {
         if (result.state === 'fulfilled') {
           if (result.value) {
@@ -70,7 +62,6 @@ function loadValidationRules(fileOrDir, platforms, callback) {
       throw err;
     }
 
-    // fileOrDir is a file
     var rules = require(fileOrDir);
     return Array.isArray(rules) ? rules : [rules];
   })  
@@ -114,7 +105,6 @@ function applyValidationRules(w3cManifestInfo, platformModules, platforms) {
   var allResults = [];
 
   function validateAllPlatforms() {
-    // load and run validation rules for "all platforms"
     var validationRulesDir = path.join(__dirname, 'validationRules');
     return loadValidationRules(validationRulesDir).then(function (rules) {
       return runValidationRules(w3cManifestInfo, rules).then(function (results) {
@@ -124,7 +114,6 @@ function applyValidationRules(w3cManifestInfo, platformModules, platforms) {
   }
 
   function validatePlatform() {
-    // run platform-specific validation rules 
     var platformTasks = platformModules.map(function (platform) {
       return platform.getValidationRules(platforms).then(function (rules) {
         return runValidationRules(w3cManifestInfo, rules).then(function (results) {
@@ -136,7 +125,6 @@ function applyValidationRules(w3cManifestInfo, platformModules, platforms) {
     return Q.allSettled(platformTasks);
   }
 
-  // Only run the "All Platform" validations for W3C manifests
   if (w3cManifestInfo.format === constants.BASE_MANIFEST_FORMAT) {
     return validateAllPlatforms()
       .then(validatePlatform)
@@ -256,7 +244,6 @@ function validateAndNormalizeStartUrl(siteUrl, manifestInfo, callback) {
     var parsedSiteUrl = url.parse(siteUrl);
     var parsedManifestStartUrl = url.parse(manifestInfo.content.start_url);
     if (parsedManifestStartUrl.hostname && parsedSiteUrl.hostname !== parsedManifestStartUrl.hostname) {
-       // issue #88 - bis
       var subDomainOfManifestStartUrlSplitted = parsedManifestStartUrl.hostname.split('.');
       var lengthSubDomain = subDomainOfManifestStartUrlSplitted.length;
       var subDomainOfManifestStartUrl = null;