Merge pull request #872 from hbugdoll/typos-fix

Author: cb1kenobi

src/cli.js

@@ -828,7 +828,7 @@ export class CLI {
 				if (sdkCommands[cmdName]) {
 					throw err;
 				}
-				// if it's not a sdk command, then it's ok if the SDK failed to load
+				// if it's not a `sdk` command, then it's ok if the SDK failed to load
 			}
 			await this.loadCommand(cmd);
 		});
@@ -1050,7 +1050,7 @@ export class CLI {
 			showSDKPrompt = true;
 		}
 
-		// load the sdk and its hooks
+		// load the SDK and its hooks
 		const {
 			installPath,
 			sdk,
@@ -1096,7 +1096,7 @@ export class CLI {
 			}
 
 			try {
-				// check if the sdk is compatible with our version of node
+				// check if the SDK is compatible with our version of node
 				sdk.packageJson = await fs.readJson(join(sdk.path, 'package.json'));
 
 				const current = process.versions.node;
@@ -1121,7 +1121,7 @@ export class CLI {
 			sdkVersion: this.sdk?.name
 		});
 
-		// if we're running a sdk command, then scan the sdk for hooks
+		// if we're running a `sdk` command, then scan the SDK for hooks
 		if (sdkCommands[cmdName]) {
 			this.debugLogger.trace('Loading SDK hooks...');
 			await this.scanHooks(expand(this.sdk.path, 'cli', 'hooks'));

src/commands/config.js

@@ -41,7 +41,7 @@ export function config(_logger, _config, _cli) {
 				desc: 'appends a value to a key containing a list of values'
 			},
 			json: {
-				desc: 'output config as json'
+				desc: 'output config as JSON'
 			},
 			remove: {
 				abbr: 'r',

src/commands/info.js

@@ -20,7 +20,7 @@ export function config(_logger, _config, _cli) {
 		skipBanner: true,
 		flags: {
 			json: {
-				desc: 'display info as json'
+				desc: 'display info as JSON'
 			}
 		},
 		options: {
@@ -178,7 +178,7 @@ export async function run(logger, config, cli) {
 
 	if (process.platform === 'darwin' && (types.all || types.ios) && data.iosKeychains) {
 		// the keychain names are the only left side label that isn't fixed length, so
-		// if we're displaying ios info, find the longest keychain name
+		// if we're displaying iOS info, find the longest keychain name
 		for (const keychain of data.iosKeychains) {
 			indent = Math.max(indent, basename(keychain).length + 2);
 		}

src/commands/module.js

@@ -82,7 +82,7 @@ ModuleSubcommands.list = {
 			desc: 'print a list of installed modules',
 			flags: {
 				json: {
-					desc: 'display installed modules as json'
+					desc: 'display installed modules as JSON'
 				}
 			},
 			options: {
@@ -139,7 +139,7 @@ ModuleSubcommands.list = {
 			}
 		}
 
-		// add any modules from various sdk locations
+		// add any modules from various SDK locations
 		if (defaultInstallLocation && !sdkLocations.includes(defaultInstallLocation)) {
 			sdkLocations.push(defaultInstallLocation);
 		}

src/commands/sdk.js

@@ -113,7 +113,7 @@ SdkSubcommands.list = {
 					desc: 'retrieve and print all branches'
 				},
 				json: {
-					desc: 'display installed modules as json'
+					desc: 'display installed modules as JSON'
 				},
 				releases: {
 					abbr: 'r',
@@ -352,7 +352,7 @@ SdkSubcommands.install = {
 
 		await mkdir(titaniumDir, { recursive: true });
 
-		// step 1: determine what the uri is
+		// step 1: determine what the URI is
 
 		const { downloadedFile, file } = await getInstallFile({
 			branch: cli.argv.branch,
@@ -363,7 +363,7 @@ SdkSubcommands.install = {
 			subject
 		});
 
-		// step 2: extract the sdk zip file
+		// step 2: extract the SDK zip file
 
 		let { forceModules, name, renameTo, tempDir } = await extractSDK({
 			debugLogger: cli.debugLogger,
@@ -396,7 +396,7 @@ SdkSubcommands.install = {
 			throw new TiError('Zip file does not contain a valid Titanium SDK');
 		}
 
-		// step 4: move the sdk files to the dest
+		// step 4: move the SDK files to the dest
 
 		const dest = join(titaniumDir, 'mobilesdk', osName, renameTo || name);
 		if (showProgress) {
@@ -487,15 +487,15 @@ async function getInstallFile({ branch, config, logger, osName, showProgress, su
 		return { file };
 	}
 
-	// we are downloading an sdk
+	// we are downloading an SDK
 
 	let url;
 	let uri = subject.toLowerCase();
 	if (uriMatch && uriMatch[1]) {
-		// we have a http url
+		// we have a http URL
 		url = uriMatch[1];
 	} else if (branch) {
-		// we have a ci build
+		// we have a CI build
 		const branches = await getBranches();
 		if (!branches.includes(branch)) {
 			throw new TiError(`Branch "${branch}" does not exist`, {
@@ -574,7 +574,7 @@ async function getInstallFile({ branch, config, logger, osName, showProgress, su
 	let m = cd && cd.match(/filename\*?=(?:[^']*'[^']*'([^;]+)|["']([^"']+)["']|([^;\s]+))/i);
 	filename = m && (m[1] || m[2] || m[3]);
 
-	// try to determine the file extension by the filename in the url
+	// try to determine the file extension by the filename in the URL
 	if (!filename && (m = url.match(/.*\/(.+\.zip)$/))) {
 		filename = m[1];
 	}

src/util/extract-zip.js

@@ -66,7 +66,7 @@ export async function extractZip(params) {
 					const symlink = (mode & fs.constants.S_IFMT) === fs.constants.S_IFLNK;
 					let isDir = (mode & fs.constants.S_IFMT) === fs.constants.S_IFDIR;
 
-					// check for windows weird way of specifying a directory
+					// check for Windows weird way of specifying a directory
 					// https://github.com/maxogden/extract-zip/issues/13#issuecomment-154494566
 					const madeBy = entry.versionMadeBy >> 8;
 					if (!isDir) {

src/util/jdk.js

@@ -26,7 +26,7 @@ export async function detect(config) {
 	};
 	const { $ } = await import('execa');
 
-	// sanity check the java home
+	// sanity check the Java home
 	if (javaHome) {
 		javaHome = expand(javaHome);
 		if (existsSync(javaHome) && isJDK(javaHome)) {

src/util/setup-screens.js

@@ -625,10 +625,10 @@ export class SetupScreens {
 					try {
 						const u = new URL(value);
 						if (!/^https?:$/.test(u.protocol)) {
-							return 'HTTP proxy url protocol must be either "http" or "https" (ex: http://user:pass@example.com)';
+							return 'HTTP proxy URL protocol must be either "http" or "https" (e.g.: http://user:pass@example.com)';
 						}
 						if (!(u.host || '')) {
-							return 'HTTP proxy url must contain a host name (ex: http://user:pass@example.com)';
+							return 'HTTP proxy URL must contain a host name (e.e.: http://user:pass@example.com)';
 						}
 						return true;
 					} catch (e) {

src/util/timodule.js

@@ -105,8 +105,8 @@ async function unzipIfNecessary(moduleRoot, name, logger) {
 }
 
 /**
- * @param {string} modulesDir i.e. '~/Library/APplication Support/Titanium/modules'
- * @param {string} platform i.e. 'android' or 'iphone'
+ * @param {string} modulesDir e.g. '~/Library/APplication Support/Titanium/modules'
+ * @param {string} platform e.g. 'android' or 'iphone'
  * @param {RegExp} osNamesRegExp regexp used to skip certain folder names like 'win32' or 'osx'
  * @param {RegExp} ignoreDirs additional regexp used to filter directories
  * @param {object} [logger] optional logger object
@@ -141,8 +141,8 @@ async function detectPlatformModules(modulesDir, platform, osNamesRegExp, ignore
 }
 
 /**
- * @param {string} platformModulesDir i.e. '~/Library/Application Support/Titanium/modules/android'
- * @param {string} moduleName i.e. 'hyperloop'
+ * @param {string} platformModulesDir e.g. '~/Library/Application Support/Titanium/modules/android'
+ * @param {string} moduleName e.g. 'hyperloop'
  * @param {RegExp} ignoreDirs regexp used to filter directories traversed
  * @param {object} [logger] optional logger object
  * @returns {Promise<object[]>}

src/util/tisdk.js

@@ -156,7 +156,7 @@ export async function initSDK({ config, cwd, debugLogger, logger, promptingEnabl
 		// might not be a project dir or bad tiapp.xml
 	}
 
-	// detect sdks
+	// detect SDKs
 	const {
 		installPath,
 		latest,