Clean comments from ProjectTools.js

Author: Lucas Rojas

lib/projectTools.js

@@ -18,28 +18,23 @@ function openVisualStudioProject (visualStudioFilePath, callback) {
   .nodeify(callback);
 }
 
-// searches for the telemetry file present in every platform project
 function searchForTelemetryFile (dir) {
   var telemetryFile = path.join(dir, constants.TELEMETRY_FILE_NAME);
   return Q.nfcall(fs.stat, telemetryFile).then(function (info) {
-    // return current directory if the name matches and it's a file
     if (info.isFile()) {
       return dir;
     }
   })
   .catch (function (err) {
-    // report any error other than not found
     if (err.code !== 'ENOENT') {
       throw err;
     }
   })
   .then (function (root) {
-    // if a result was found, return it
     if (root) {
       return root;
     }
 
-    // search parent directory unless we are already at the root
     var parentPath = path.resolve(dir, '..');
     if (parentPath !== dir) {
       return searchForTelemetryFile(parentPath);
@@ -48,13 +43,9 @@ function searchForTelemetryFile (dir) {
 }
 
 function isProjectRoot (dir) {
-  // get available app categories
   var appTypes = [ constants.PWA_FOLDER, constants.POLYFILLS_FOLDER ];
-
-  // get available platform IDs
   var platforms = platformTools.listPlatforms();
 
-  // search child platform folders
   return Q.nfcall(fs.readdir, dir).then(function (files) {
     var searchTasks = files.map(function (file) {
 
@@ -68,7 +59,6 @@ function isProjectRoot (dir) {
         return Q.resolve(false);
       }
 
-      // search for telemetry file in the platform folder
       var platformDir = path.join(dir, file);
       return searchForTelemetryFile(platformDir).then(function (result) {
         return result;
@@ -84,23 +74,19 @@ function isProjectRoot (dir) {
   });
 }
 
-// given a path within a pwabuilder project, returns its root
 function getProjectRoot (dir) {
   var insidePWA = new RegExp(constants.PWA_FOLDER + '$');
   var insidePolyfills = new RegExp(constants.POLYFILLS_FOLDER + '$');
 
-  // check if this is the project root
   return isProjectRoot(dir).then(function (isRoot) {
     if (isRoot) {
       return dir;
     } else if (dir.match(insidePWA) || dir.match(insidePolyfills)) {
       return getProjectRoot(path.resolve(dir, '..'));
     }
 
-    // search for a platform folder containing telemetry file
     return searchForTelemetryFile(dir).then(function (filePath) {
       if (filePath) {
-        // start search for project root from the platform folder
         var parentPath = path.resolve(filePath, '..');
         if (parentPath !== dir) {
           return getProjectRoot(parentPath);
@@ -125,7 +111,6 @@ function getProjectRoot (dir) {
 function getProjectPlatformsRecursivelly (dir, configuredPlatforms, foundPlatforms) {
     if (!foundPlatforms) { foundPlatforms = []; }
 
-    // search recursivelly for telemetry files or known platform folders with telemetry matching info inside
     return Q.nfcall(fs.readdir, dir).then(function (files) {
       var searchPlatformTasks = files.map(function (file) {
         var extendedDir = path.join(dir, file);
@@ -141,7 +126,6 @@ function getProjectPlatformsRecursivelly (dir, configuredPlatforms, foundPlatfor
               });
             }
           } else if (configuredPlatforms[file]) {
-            // try to open telemetry file within folder (if exists - otherwise not interesting folder)
             var telemetryFile = path.join(extendedDir, constants.TELEMETRY_FILE_NAME);
             return Q.nfcall(fs.readFile, telemetryFile, 'utf8').then(function(data) {
               var generationInfo = JSON.parse(data);
@@ -164,7 +148,6 @@ function getProjectPlatformsRecursivelly (dir, configuredPlatforms, foundPlatfor
 }
 
 function getProjectPlatforms (dir) {
-  // get available platform IDs
   var configuredPlatforms = platformTools.getConfiguredPlatforms();
 
   return getProjectRoot(dir || process.cwd()).then(function (rootDir) {