Clean comments from packagetools.js

Author: Lucas Rojas

lib/packageTools.js

@@ -19,7 +19,6 @@ var packageJson = 'package.json';
 var installTask;
 var installQueue = [];
 
-// downloads a file
 function downloadFile (inputUri, callback) {
 
   var uri = url.parse(inputUri);
@@ -44,7 +43,6 @@ function downloadFile (inputUri, callback) {
         return deferred.resolve({ 'statusCode': res.statusCode, 'statusMessage': res.statusMessage, 'contentType': res.headers['content-type'], 'data': buffer });
       }
 
-      // If status is Moved Permanently or Found, redirect to new URL
       if ([301, 302].indexOf(res.statusCode) > -1) {
         return downloadFile(res.headers.location)
           .then(function (result) { deferred.resolve(result); })
@@ -62,7 +60,6 @@ function downloadFile (inputUri, callback) {
   return deferred.promise.nodeify(callback);
 }
 
-// returns package information (package.json) given a package name 
 function getPackageInformation (packageName, parentPackagePath) {
 
   try {
@@ -94,7 +91,6 @@ function getPackageInformation (packageName, parentPackagePath) {
   throw new Error('Error retrieving information for module: \'' + (packageName || 'main') + '\'.');
 }
 
-// returns package information (package.json) given a file or directory 
 function getModuleInformation (dir) {
 
   try {
@@ -124,7 +120,6 @@ function getModuleInformation (dir) {
   throw new Error('Error retrieving information for module: \'' + (dir || 'main') + '\'.');
 } 
 
-// get package information from the npm registry
 function getNpmPackageInfo (packageName, callback) {
   var deferred = Q.defer();
   http.get('http://registry.npmjs.org/' + packageName + '/latest', function (res) {
@@ -155,7 +150,6 @@ function getNpmPackageInfo (packageName, callback) {
   return deferred.promise.nodeify(callback);
 }
 
-// get package information from a GitHub repository
 function getGitHubPackageInformation (repositoryUrl, callback) {
 
   var src = url.parse(repositoryUrl);
@@ -187,15 +181,13 @@ function getGitHubPackageInformation (repositoryUrl, callback) {
   });
 }
 
-// get the latest version for an npm package
 function getNpmPackageLatestVersion (packageName, callback) {
   return getNpmPackageInfo(packageName).then(function (packageJson) {
     return packageJson.version;
   })
   .nodeify(callback);
 }
 
-// checks for updates to the application
 function checkForUpdate (callback) {
 
   var mainModule = getPackageInformation();
@@ -206,12 +198,10 @@ function checkForUpdate (callback) {
   .nodeify(callback);
 }
 
-// installs an npm package
 function installPackage (packageName, source, callback) {
 
   log.info('Installing new module: ' + packageName);
 
-  // npm command in Windows is a batch file and needs to include extension to be resolved by spawn call
   var npm = (process.platform === 'win32' ? 'npm.cmd' : 'npm');
   var appRoot = path.dirname(utils.getRootPackagePath());
   return exec(npm, ['install', source], { cwd: appRoot, statusMessage: 'Installing package ' }).then(function () {
@@ -240,7 +230,6 @@ function queuePackageInstallation (packageName, source, callback) {
   return installTask.promise.nodeify(callback);
 }
 
-// Triggers the installation of all queued npm packages.
 function installQueuedPackages () {
 
   if (installQueue.length === 0) {
@@ -251,25 +240,20 @@ function installQueuedPackages () {
 
   log.info('Installing the following module(s): \'' + moduleList + '\'...');
 
-  // npm command in Windows is a batch file and needs to include extension to be resolved by spawn call
   var npm = (process.platform === 'win32' ? 'npm.cmd' : 'npm');
   var appRoot = path.dirname(utils.getRootPackagePath());
 
-  // build package list                    
   var sources = installQueue.map(function (item) { 
     return item.source;
   });
 
-  // launch npm  
   return exec(npm, ['install'].concat(sources), { cwd: appRoot, statusMessage: 'Installing packages '  }).then(function () {
-    // signal completion
     installTask.resolve(installQueue);
   })
   .catch(function (err) {
     return installTask.reject(new CustomError('Failed to install the following module(s): \'' + moduleList + '\'.', err));
   })
   .finally(function () {
-    // clear queue
     installTask = undefined;
     installQueue = [];      
   });