fix: further typos and wording

Author: hbugdoll

android/hooks/tasks/generate-metabase-task.js

@@ -8,7 +8,7 @@ const metabase = require('../metabase');
  * A task that will generate the Android metabase
  *
  * This is implemented as a simple base task because the metabase generation
- * itself has a caching machanisim, so we just delegate and return the result.
+ * itself has a caching mechanism, so we just delegate and return the result.
  */
 class GenerateMetabaseTask extends BaseFileTask {
 
@@ -52,7 +52,7 @@ class GenerateMetabaseTask extends BaseFileTask {
 	}
 
 	/**
-	 * Gets the generated metabse
+	 * Gets the generated metabase
 	 *
 	 * @return {Object} Metabase object
 	 */

android/hooks/tasks/generate-sources-task.js

@@ -41,7 +41,7 @@ class GenerateSourcesTask extends IncrementalFileTask {
 	}
 
 	/**
-	 * Metabase that will be used to genrate the warpper files
+	 * Metabase that will be used to generate the wrapper files
 	 *
 	 * @return {Object} Metabase object
 	 */
@@ -84,7 +84,7 @@ class GenerateSourcesTask extends IncrementalFileTask {
 	}
 
 	/**
-	 * Does a full task run, wich will generate the Hyperloop wrapper for every
+	 * Does a full task run, which will generate the Hyperloop wrapper for every
 	 * referenced Java class
 	 *
 	 * @return {Promise}
@@ -149,7 +149,7 @@ class GenerateSourcesTask extends IncrementalFileTask {
 	}
 
 	/**
-	 * Removes any unused class wrappers from the output directoy
+	 * Removes any unused class wrappers from the output directory
 	 *
 	 * @param {Array.<String>} classesToRemove Array of class names
 	 * @return {Promise}
@@ -259,7 +259,7 @@ class GenerateSourcesTask extends IncrementalFileTask {
 	/**
 	 * Loads the class list used in incremental task runs
 	 *
-	 * @return {Promise<Boolean>} True if the files was loaded succesfully, false if not
+	 * @return {Promise<Boolean>} True if the files was loaded successfully, false if not
 	 */
 	async loadClassList() {
 		try {

documentation/ios.md

@@ -353,7 +353,7 @@ module.exports = {
 };
 ```
 
-Any `flags` added to the `xcodebuild` property will be passed to `xcodebuild`. Any `frameworks` in the array provided will be automatically added to the xcode project.  _Note: any referenced frameworks in your Hyperloop code are automatically added for you. However, this gives you even more control to custom your compile environment._
+Any `flags` added to the `xcodebuild` property will be passed to `xcodebuild`. Any `frameworks` in the array provided will be automatically added to the Xcode project.  _Note: any referenced frameworks in your Hyperloop code are automatically added for you. However, this gives you even more control to custom your compile environment._
 
 ### Adding a third-party framework
 

iphone/hooks/hyperloop.js

@@ -173,7 +173,7 @@ HyperloopiOSBuilder.prototype.validate = function validate() {
 		process.exit(1);
 	}
 
-	// check for min ios version
+	// check for min iOS version
 	if (this.appc.version.lt(this.builder.minIosVer, IOS_MIN)) {
 		this.logger.error('Hyperloop compiler works best with iOS ' + IOS_MIN + ' or greater.');
 		this.logger.error('Your setting is currently set to: ' + (this.builder.tiapp.ios['min-ios-ver'] || this.builder.minIosVer));
@@ -1240,7 +1240,7 @@ HyperloopiOSBuilder.prototype.updateXcodeProject = function updateXcodeProject()
 		}, this);
 	}
 
-	// add the source files to xcode to compile
+	// add the source files to Xcode to compile
 	if (nativeModules.length) {
 		groups['Native'] || (groups['Native'] = {});
 		nativeModules.forEach(function (mod) {
@@ -1426,7 +1426,7 @@ HyperloopiOSBuilder.prototype.hasCustomShellScriptBuildPhases = function hasCust
  * @param {Object} data - The hook payload.
  */
 HyperloopiOSBuilder.prototype.hookRemoveFiles = function hookRemoveFiles(data) {
-	// remove empty Framework directory that might have been created by cocoapods
+	// remove empty Framework directory that might have been created by CocoaPods
 	var frameworksDir = path.join(this.builder.xcodeAppDir, 'Frameworks');
 	if (fs.existsSync(frameworksDir) && fs.readdirSync(frameworksDir).length === 0) {
 		fs.removeSync(frameworksDir);

packages/hyperloop-ios-metabase/lib/metabase.js

@@ -19,7 +19,7 @@ var spawn = require('child_process').spawn,
 
 
 /**
- * return the configured SDK path
+ * Returns the configured SDK path
  */
 function getSDKPath (sdkType, callback) {
 	exec('/usr/bin/xcrun --sdk ' + sdkType + ' --show-sdk-path', function (err, stdout) {
@@ -29,7 +29,7 @@ function getSDKPath (sdkType, callback) {
 }
 
 /**
- * convert an apple style version (9.0) to a semver compatible version
+ * Converts an Apple style version (9.0) to a semver compatible version
  */
 function appleVersionToSemver (ver) {
 	var v = String(ver).split('.');
@@ -43,7 +43,7 @@ function appleVersionToSemver (ver) {
 }
 
 /**
- * return a parsed plist for a given framework
+ * Returns a parsed plist for a given framework
  */
 function getPlistForFramework (info, callback) {
 	if (fs.existsSync(info)) {
@@ -203,7 +203,7 @@ class ModuleMetadata {
 	}
 
 	/**
-	 * Prases a plain object received from JSON data and converts it back to a
+	 * Parses a plain object received from JSON data and converts it back to a
 	 * module metadata instance.
 	 *
 	 * @param {Object} json Object containing data from JSON
@@ -221,7 +221,7 @@ class ModuleMetadata {
 }
 
 /**
- * generate system framework includes mapping
+ * Generates system framework includes mapping
  */
 function generateSystemFrameworks (sdkPath, iosMinVersion, callback) {
 	const frameworksPath = path.resolve(path.join(sdkPath, 'System/Library/Frameworks'));
@@ -260,7 +260,7 @@ function generateSystemFrameworks (sdkPath, iosMinVersion, callback) {
  * mapped to the parent framework.
  *
  * @param {String} frameworkName Name of the framework
- * @param {String} frameworkPath Full path to the framwork
+ * @param {String} frameworkPath Full path to the framework
  * @param {Object} includes Object with all include mappings
  */
 function extractImplementationsFromFramework(frameworkName, frameworkPath, includes) {
@@ -276,7 +276,7 @@ function extractImplementationsFromFramework(frameworkName, frameworkPath, inclu
  * Iterates over a framework's Headers directory and any nested frameworks to
  * collect the paths to all available header files of a framework.
  *
- * @param {String} frameworkPath Full path to the framwork
+ * @param {String} frameworkPath Full path to the framework
  * @return {Array} List with paths to all found header files
  */
 function collectFrameworkHeaders(frameworkPath) {
@@ -300,11 +300,11 @@ function collectFrameworkHeaders(frameworkPath) {
 }
 
 /**
- * generate a metabase
+ * Generates a metabase
  *
  * @param {String} buildDir cache directory to write the files
- * @param {String} sdk the sdk type such as iphonesimulator
- * @param {String} sdk path the path to the SDK
+ * @param {String} sdk the SDK type such as iphonesimulator
+ * @param {String} sdkPath the path to the SDK
  * @param {String} iosMinVersion the min version such as 9.0
  * @param {Array} includes array of header paths (should be absolute paths)
  * @param {Boolean} excludeSystem if true, will exclude any system libraries in the generated output
@@ -413,7 +413,7 @@ function generateMetabase (buildDir, sdk, sdkPath, iosMinVersion, includes, excl
 }
 
 /**
- * return the system frameworks mappings as JSON for a given sdkType and minVersion
+ * Returns the system frameworks mappings as JSON for a given sdkType and minVersion
  */
 function getSystemFrameworks (cacheDir, sdkType, minVersion, callback) {
 	var fn = 'metabase-mappings-' + sdkType + '-' + minVersion + '.json';
@@ -456,7 +456,7 @@ function recursiveReadDir (dir, result) {
 }
 
 /**
- * for an array of directories, return all validate header files
+ * For an array of directories, returns all validate header files
  */
 function getAllHeaderFiles (directories) {
 	var files = [];
@@ -861,7 +861,7 @@ function getBuiltProductsRootPath (basePath, configurationName, sdkType) {
  * Gets JSON encoded data from a cache file.
  *
  * @param {String} cacheDir Path to the cache directory
- * @param {String} cacheToken Hash to identifiy the required cache file
+ * @param {String} cacheToken Hash to identify the required cache file
  * @return {Object} The CocoaPods metabase mappings
  */
 function readFromCache (cachePathAndFilename) {
@@ -939,7 +939,7 @@ function readModulesMetadataFromCache(cachePathAndFilename) {
 
 
 /**
- * handle buffer output
+ * Handles buffer output
  */
 function createLogger (obj, fn) {
 	return (function () {
@@ -965,7 +965,7 @@ function createLogger (obj, fn) {
 }
 
 /**
- * run the ibtool
+ * Runs the ibtool
  */
 function runIBTool (runDir, args, callback) {
 	var spawn = require('child_process').spawn,
@@ -1132,7 +1132,7 @@ function runCocoaPodsBuild (basedir, builder, callback) {
 }
 
 /**
- * parse the xcconfig file
+ * Parses the xcconfig file
  */
 function parseCocoaPodXCConfig (fn) {
 	var config = {};
@@ -1148,7 +1148,7 @@ function parseCocoaPodXCConfig (fn) {
 }
 
 /**
- * generate a map of xcode settings for CocoaPods
+ * Generates a map of Xcode settings for CocoaPods
  */
 function getCocoaPodsXCodeSettings (basedir) {
 	var podDir = path.join(basedir, 'Pods');

tools/ci.js

@@ -361,7 +361,7 @@ function writeAndroidManifest(next) {
 }
 
 /**
- * write the updated ios manifest if necessary
+ * write the updated iOS manifest if necessary
  */
 function writeiOSManifest(next) {
 	var fn = path.join(__dirname, '..', 'iphone', 'manifest'),
@@ -378,7 +378,7 @@ function writeiOSManifest(next) {
 }
 
 /**
- * write the updated android plugin package.json if neccesary
+ * write the updated android plugin package.json if necessary
  */
 function writeAndroidPluginPackage (next) {
 	var fn = path.join(__dirname, '..', 'android', 'plugins', 'hyperloop', 'hooks', 'android', 'package.json'),
@@ -440,8 +440,7 @@ function build(branch, callback) {
 				next();
 			});
 		},
-		// TODO Do we need to install xcode or something?
-		// TODO Install python if it's not installed?
+		// TODO Do we need to install Xcode or something?
 
 		// Grab the paths to Android NDK and SDK
 		function (next) {