Clean comments form platformbase.js

Author: Lucas Rojas

lib/platformBase.js

@@ -21,14 +21,9 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
   self.packageName = packageName;
   self.baseDir = baseDir;
   self.log = log;
-
-  // default for platform category
   self.isPWA = false;
-
-  // default for images output
   self.imagesSubfolder = 'Images';
 
-  // get extended configuration settings if available
   if (extendedCfg) {
     self.isPWA = extendedCfg.isPWA;
     self.targetFolder = extendedCfg.targetFolder;
@@ -75,28 +70,19 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
     return Q.resolve().nodeify(callback);
   };
 
-  /**
-   * Loads validation rules from the 'validationRules' folder of the platform project. The
-   * validation rules ensure the W3C manifest meets the requirements for your platform.
-   *
-   * This function is optional. A platform should override it to use a different strategy for
-   * loading its validation rules.
-   */
-  self.getValidationRules = function (platforms, callback) {
+   self.getValidationRules = function (platforms, callback) {
     if (!self.baseDir) {
       self.warn('Missing base directory for platform: ' + self.id + '.');
       return Q.resolve([]).nodeify(callback);
     }
 
-    // first look for a 'validationRules' directory
     var validationRulesDir = path.join(self.baseDir, 'validationRules');
     return Q.nfcall(fs.stat, validationRulesDir).then(function (stats) {
       if (stats.isDirectory()) {
         return manifestTools.loadValidationRules(validationRulesDir, platforms);
       }
     })
     .catch(function () {
-      // then look for a 'validationRules.js' file
       var validationRulesFile = validationRulesDir + '.js';
       return Q.nfcall(fs.stat, validationRulesFile).then(function (stats) {
         if (stats.isFile()) {
@@ -112,7 +98,7 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
 
   /**
    * Returns an array of icons files as defined in the manifest. The method assumes that all icons
-   * are are square and defined as properties of an 'icons' member, for example:
+   * are square and defined as properties of an 'icons' member, for example:
    *   "icons": {
    *       "30": "/images/smalllogo.png",
    *       "50": "/images/storelogo.png",
@@ -171,9 +157,6 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
     return iconFromGetManifestIcons.fileName || utils.newGuid() + '.png';
   };
 
-  /**
-   * Returns the icon uri for an embedded icon in order to set it within the original W3C manifest
-   */
   self.updateEmbeddedIconUriW3C = function(uri) {
     return uri;
   };
@@ -192,7 +175,6 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
   self.updateEmbeddedIconUri = function(manifest, iconFromGetManifestIcons, uri) {
     uri = ('/' + uri).replace('//', '/');
 
-    // updates the converted platform manifest
     var oldUri = iconFromGetManifestIcons.url || iconFromGetManifestIcons;
     if (iconFromGetManifestIcons.url) {
       iconFromGetManifestIcons.url = uri;
@@ -204,7 +186,6 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
       });
     }
 
-    // if __w3cManifestInfo is also provided then update it
     if (manifest.__w3cManifestInfo && manifest.__w3cManifestInfo.content) {
       (manifest.__w3cManifestInfo.content.icons || [ ]).forEach(function(icon) {
         if (icon.src === oldUri) {
@@ -278,13 +259,11 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
   self.downloadIcons = function (manifest, baseUrl, imagesOutputInfo, callback) {
     self.debug('Downloading the ' + self.id + ' icons...');
 
-    // defaults for images output folder and manifest icons' path updates
     var rootDir = imagesOutputInfo;
     var imagesDir = imagesOutputInfo;
     var relativePath = '';
     var updatePaths = false;
 
-    // if the imagesOutputInfo is object with content
     if (imagesOutputInfo.rootFolder) {
       self.debug('Overriding defaults with custom images info: ' + JSON.stringify(imagesOutputInfo));
 
@@ -294,7 +273,6 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
       updatePaths = imagesOutputInfo.updatePaths;
     }
 
-    // download the icons specified in the manifest
     var iconList = manifest.icons;
     return Q.resolve().then(function () {
       if (iconList) {
@@ -321,25 +299,19 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
           });
         });
       }
-    }).then(function () { // copy default platform icons to replace any missing icons
-      // if the platform provided the input w3c manifest then remove it as it's no longer needed
+    }).then(function () { 
       delete(manifest.__w3cManifestInfo);
 
       var defaultImagesDir = path.join(self.baseDir, 'assets', 'images');
       return fileTools.syncFiles(defaultImagesDir, imagesDir, {
-        // filter out default images that do not need to be moved over
         filter: function (file) {
-          // determine the icon dimensions assuming a convention where
-          // the file name specifies the icon's size (e.g. '50x50.png')
           var size = path.basename(file, path.extname(file));
           return !self.getManifestIcon(manifest, size);
         }
       }).then(function (files) {
         files.forEach(function (file) {
-          // make path relative to imagesDir
           var filePath = path.relative(imagesDir, file);
 
-          // convention is for file name to specify the icon's size
           var size = path.basename(file, path.extname(file));
           self.addManifestIcon(manifest, filePath, size);
         });
@@ -358,10 +330,6 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
     }).nodeify(callback);
   };
 
-  /**
-  * Copies the documentation to the generated app's folder. All documents must be placed in
-  * the 'docs' folder of the platform.
-  */
   self.copyDocumentation = function (targetPath, platform, callback) {
 
     if (arguments.length > 1) {
@@ -376,16 +344,11 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
     self.info('Copying documentation from \'' + sourcePath + '\' to \'' + targetPath + '\'...');
 
     return fileTools.copyFolder(sourcePath, targetPath).catch (function (err) {
-      // failure to copy the documentation is not considered fatal, so catch the error and log as a warning
       self.warn('Failed to copy the documentation for the \'' + platform + '\' Cordova platform. ' + err.getMessage());
     })
     .nodeify(callback);
   };
 
-  /**
-  * Writes 'telemetry' information to the generated app's folder, including generation tool version,
-  * platform package version, generated app URL, and generation date.
-  */
   self.writeGenerationInfo = function (manifestInfo, targetPath, callback) {
     var appModule = packageTools.getPackageInformation();
     if (!appModule) {
@@ -421,24 +384,15 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
             .nodeify(callback);
   };
 
-  /**
-   * Returns bool value indicating if the module is PWA or not
-   */
   self.isPWAPlatform = function() {
     return self.isPWA;
   };
 
-  /**
-   * Returns the intermediate output folder
-   */
   self.getOutputFolder = function(rootDir) {
     var targetFolder = self.targetFolder ? self.targetFolder : self.id;
     return path.join(rootDir, targetFolder);
   };
 
-  /**
-   * Returns the info for image's output generation
-   */
   self.getOutputImagesInfo = function(rootDir) {
     return {
       rootFolder: rootDir,
@@ -448,37 +402,22 @@ function PlatformBase (id, name, packageName, baseDir, extendedCfg) {
     };
   };
 
-  /**
-   * Outputs a debug message to the log.
-   */
   self.debug = function (message, source) {
     self.log.debug(message, source || self.id);
   };
 
-  /**
-   * Outputs an informational message to the log.
-   */
   self.info = function (message, source) {
     self.log.info(message, source || self.id);
   };
 
-  /**
-   * Outputs a warning message to the log.
-   */
   self.warn = function (message, source) {
     self.log.warn(message, source || self.id);
   };
 
-  /**
-   * Outputs an informational message to the log.
-   */
   self.error = function (message, source) {
     self.log.error(message, source || self.id);
   };
 
-  /**
-   * Outputs a message to the log regardless of the configured logging level.
-   */
   self.write = function (message, source) {
     self.log.write(message, source || self.id);
   };