Clen comments from platformtools.js

Author: Lucas Rojas

lib/platformTools.js

@@ -34,8 +34,6 @@ function getPlatformModule(packageName, source) {
       return Q.reject(new CustomError('Failed to resolve module: \'' + packageName + '\'.', err));
     }
 
-    // queue the installation of the package, it will be installed once installQueuedPackages
-    // is called, then re-attempt to require the package.
     return packageTools.queuePackageInstallation(packageName, source).then(function() {
       var module = require(packageName);
       return Q.resolve(module);
@@ -51,14 +49,11 @@ function loadPlatform(packageName, source, callback) {
   .nodeify(callback);
 }
 
-// configures the platforms with the provided configuration or attempts to load
-// the configuration from a 'platforms.json' file in the root of the main app
 function configurePlatforms(config) {
   if (!config) {
     config = getDefaultConfigPath();
   }
 
-  // if config is a file path, load the file
   if (config && typeof config === 'string') {
     try {
       config = require(config);
@@ -71,7 +66,6 @@ function configurePlatforms(config) {
   platformConfiguration = config;
 }
 
-// returns the modules implementing the requested platforms
 function loadPlatforms(platforms, config, callback) {
 
   if (arguments.length < 3) {
@@ -81,25 +75,19 @@ function loadPlatforms(platforms, config, callback) {
     }
   }
 
-  // if configurePlatforms has not been called yet, loads the default configuration
   configurePlatforms(config || platformConfiguration);
 
   var platformMap = {};
-  // load all platform modules and map the corresponding platforms to each one, taking into account that
-  // multiple platforms may map to a single module (e.g. pwabuilder-cordova => android, ios, windows...)
   var tasks = (platforms || []).reduce(function (taskList, platformId) {
 
-    // ensure that the platform is registered and is assigned a package name
     var platformInfo = platformConfiguration[platformId];
     if (platformInfo && platformInfo.packageName) {
       var packageName = platformInfo.packageName;
 
-      // check if the module has already been loaded
       var platformList = platformMap[packageName];
 
       if (!platformList) {
 
-        // create a new task to load the platform module
         platformMap[packageName] = platformList = [];
         var task = loadPlatform(packageName, platformInfo.source).then(function(Platform) {
           return { packageName: packageName, Platform: Platform, platforms: platformList };
@@ -108,7 +96,6 @@ function loadPlatforms(platforms, config, callback) {
         taskList.push(task);
       }
 
-      // assign the current platform to the module
       platformList.push(platformId);
     }
     else {
@@ -118,14 +105,11 @@ function loadPlatforms(platforms, config, callback) {
     return taskList;
   }, []);
 
-  // launch the installation of all queued packages
   packageTools.installQueuedPackages();
 
-  // wait for all modules to load
   return Q.allSettled(tasks).then(function (results) {
     return results.reduce(function (modules, result) {
       if (result.state === 'fulfilled') {
-        // create instances of each platform module
         var module = result.value;
         modules.push(new module.Platform(module.packageName, module.platforms));
       }
@@ -136,25 +120,19 @@ function loadPlatforms(platforms, config, callback) {
   .nodeify(callback);
 }
 
-// get the platform package information (package.json)
 function getPlatformPackageInfo (id, callback) {
-  /* jshint unused: vars */
-  // check if package is in the npm registry
   return packageTools.getNpmPackageInfo(id).catch(function (err) {
     log.debug('Failed to locate the plaform package in the npm registry...');
-    // check if package is in a GitHub repository
     return packageTools.getGitHubPackageInformation(id);
   })
   .catch(function (err) {
     log.debug('Failed to locate the plaform package in GitHub...');
     try {
-      // check if package is in a local path
       return packageTools.getModuleInformation(id);
     }
     catch (err) {
       log.debug('Failed to locate the plaform package in the local disk...');
       try {
-        // check if package is in an installed module
         return packageTools.getPackageInformation(id);
       }
       catch (err) {
@@ -212,15 +190,12 @@ function removePlatform(platformId, configPath, callback) {
 }
 
 function getConfiguredPlatforms(configPath) {
-  // if configurePlatforms has not been called yet, loads the default configuration
   configurePlatforms(configPath || platformConfiguration);
 
-  // return all registered platforms
   return platformConfiguration;
 }
 
 function listPlatforms(configPath) {
-  // return all registered platforms
   return Object.keys(getConfiguredPlatforms(configPath));
 }