Merge pull request #492 from NativeScript/fatme/refactor-options

Refactor options

Author: Fatme

lib/bootstrap.ts

@@ -1,6 +1,6 @@
 require("./common/bootstrap");
 $injector.require("config", "./config");
-require("./options");
+$injector.require("options", "./options");
 // note: order above is important!
 $injector.require("nativescript-cli", "./nativescript-cli");
 

lib/common

@@ -30,3 +30,18 @@ interface ILockFile {
 interface IOpener {
     open(target: string, appname: string): void;
 }
+
+interface IOptions extends ICommonOptions {
+	frameworkPath: string;
+	copyFrom: string;
+	linkTo: string;
+	release: boolean;
+	emulator: boolean;
+	symlink: boolean;
+	forDevice: boolean;
+	client: boolean;
+	keyStorePath: string;
+	keyStorePassword: string;
+	keyStoreAlias: string;
+	keyStoreAliasPassword: string;
+}

lib/declarations.ts

@@ -4,10 +4,14 @@
 import Future = require("fibers/future");
 import lockfile = require("lockfile");
 import path = require("path");
-import options = require("./common/options");
 
 export class LockFile implements ILockFile {
-	private static LOCK_FILENAME = path.join(options["profile-dir"], ".lock");
+	private lockFilePath: string;
+	
+	constructor(private $options: IOptions) {
+		this.lockFilePath = path.join(this.$options.profileDir, ".lock");
+	}
+	
 	private static LOCK_EXPIRY_PERIOD_SEC = 180;
 	private static LOCK_PARAMS = {
 		retryWait: 100,
@@ -17,7 +21,7 @@ export class LockFile implements ILockFile {
 
 	public lock(): IFuture<void> {
 		var future = new Future<void>();
-		lockfile.lock(LockFile.LOCK_FILENAME, LockFile.LOCK_PARAMS, (err: Error) => {
+		lockfile.lock(this.lockFilePath, LockFile.LOCK_PARAMS, (err: Error) => {
 			if(err) {
 				future.throw(err);
 			} else {
@@ -29,7 +33,7 @@ export class LockFile implements ILockFile {
 
 	public unlock(): IFuture<void> {
 		var future = new Future<void>();
-		lockfile.unlock(LockFile.LOCK_FILENAME, (err: Error) => {
+		lockfile.unlock(this.lockFilePath, (err: Error) => {
 			if(err) {
 				future.throw(err);
 			} else {

lib/lockfile.ts

@@ -8,7 +8,6 @@ import semver = require("semver");
 import shell = require("shelljs");
 import helpers = require("./common/helpers");
 import constants = require("./constants");
-import options = require("./common/options");
 
 export class NodePackageManager implements INodePackageManager {
 	private static NPM_LOAD_FAILED = "Failed to retrieve data from npm. Please try again a little bit later.";
@@ -19,7 +18,8 @@ export class NodePackageManager implements INodePackageManager {
 	constructor(private $logger: ILogger,
 		private $errors: IErrors,
 		private $fs: IFileSystem,
-		private $lockfile: ILockFile) {
+		private $lockfile: ILockFile,
+		private $options: IOptions) {
 		this.versionsCache = {};
 		this.load().wait();
 	}
@@ -94,14 +94,14 @@ export class NodePackageManager implements INodePackageManager {
 
 	private installCore(packageName: string, pathToSave: string, version: string): IFuture<string> {
 		return (() => {
-			if (options.frameworkPath) {
-				if (this.$fs.getFsStats(options.frameworkPath).wait().isFile()) {
+			if (this.$options.frameworkPath) {
+				if (this.$fs.getFsStats(this.$options.frameworkPath).wait().isFile()) {
 					this.npmInstall(packageName, pathToSave, version).wait();
 					var pathToNodeModules = path.join(pathToSave, "node_modules");
 					var folders = this.$fs.readDirectory(pathToNodeModules).wait();
 					return path.join(pathToNodeModules, folders[0]);
 				}
-				return options.frameworkPath;
+				return this.$options.frameworkPath;
 			} else {
 				version = version || this.getLatestVersion(packageName).wait();
 				var packagePath = this.getCachedPackagePath(packageName, version);
@@ -121,7 +121,7 @@ export class NodePackageManager implements INodePackageManager {
 		this.$logger.out("Installing ", packageName);
 
 		var incrementedVersion = semver.inc(version, constants.ReleaseType.MINOR);
-		if (!options.frameworkPath && packageName.indexOf("@") < 0) {
+		if (!this.$options.frameworkPath && packageName.indexOf("@") < 0) {
 			packageName = packageName + "@<" + incrementedVersion;
 		}
 

lib/node-package-manager.ts

@@ -1,46 +1,32 @@
 ///<reference path=".d.ts"/>
 "use strict";
 
-import path = require("path");
-import commonOptions = require("./common/options");
+import commonOptionsLibPath = require("./common/options");
 import osenv = require("osenv");
-import hostInfo = require("./common/host-info");
-
-var knownOpts: any = {
-		"frameworkPath": String,
-		"copy-from": String,
-		"link-to": String,
-		"release": Boolean,
-		"emulator": Boolean,
-		"symlink": Boolean,
-		"for-device": Boolean,
-		"client": Boolean,
-		"keyStorePath": String,
-		"keyStorePassword": String,
-		"keyStoreAlias": String,
-		"keyStoreAliasPassword": String
-	},
-	shorthands: IStringDictionary = {
-	};
+import path = require("path");
 
-_.extend(commonOptions.knownOpts, knownOpts);
-_.extend(commonOptions.shorthands, shorthands);
+let OptionType = commonOptionsLibPath.OptionType;
 
-var defaultProfileDir = "";
-var nativeScriptCacheFolder = ".nativescript-cli";
-if(hostInfo.isWindows()) {
-	defaultProfileDir = path.join(process.env.LocalAppData, nativeScriptCacheFolder);
-} else {
-	defaultProfileDir = path.join(osenv.home(), ".local/share", nativeScriptCacheFolder);
+export class Options extends commonOptionsLibPath.OptionsBase {
+	constructor($errors: IErrors,
+		$staticConfig: IStaticConfig,
+		$hostInfo: IHostInfo) {
+		super({
+			frameworkPath: { type: OptionType.String },
+			copyFrom: { type: OptionType.String },
+			linkTo: { type: OptionType.String  },
+			release: { type: OptionType.Boolean },
+			emulator: { type: OptionType.Boolean },
+			symlink: { type: OptionType.Boolean },
+			forDevice: { type: OptionType.Boolean },
+			client: { type: OptionType.Boolean },
+			keyStorePath: { type: OptionType.String },
+			keyStorePassword: { type: OptionType.String,},
+			keyStoreAlias: { type: OptionType.String },
+			keyStoreAliasPassword: { type: OptionType.String }
+		},
+		path.join($hostInfo.isWindows ? process.env.LocalAppData : path.join(osenv.home(), ".local/share", "Telerik", "BlackDragon", ".nativescript-cli")),
+			$errors, $staticConfig);
+	}
 }
-
-commonOptions.setProfileDir(defaultProfileDir);
-var errors: IErrors = $injector.resolve("errors");
-_(errors.validateArgs("tns", commonOptions.knownOpts, commonOptions.shorthands)).each((val,key) => {
-	key = shorthands[key] || key;
-	commonOptions[key] = val;
-}).value();
-exports.knownOpts = knownOpts;
-
-declare var exports:any;
-export = exports;
+$injector.register("options", Options);

lib/options.ts

@@ -4,7 +4,6 @@
 import constants = require("./constants");
 import path = require("path");
 import os = require("os");
-import options = require("./common/options");
 
 export class ProjectData implements IProjectData {
 	private static OLD_PROJECT_FILE_NAME = ".tnsproject";
@@ -19,7 +18,8 @@ export class ProjectData implements IProjectData {
 		private $errors: IErrors,
 		private $logger: ILogger,
 		private $projectHelper: IProjectHelper,
-		private $staticConfig: IStaticConfig) {
+		private $staticConfig: IStaticConfig,
+		private $options: IOptions) {
 		this.initializeProjectData().wait();
 	}
 
@@ -56,12 +56,12 @@ export class ProjectData implements IProjectData {
 	}
 
 	private throwNoProjectFoundError(): void {
-		this.$errors.fail("No project found at or above '%s' and neither was a --path specified.", options.path || path.resolve("."));
+		this.$errors.fail("No project found at or above '%s' and neither was a --path specified.", this.$options.path || path.resolve("."));
 	}
 
 	private tryToUpgradeProject(): IFuture<void> {
 		return (() => {
-			let projectDir = this.projectDir || path.resolve(options.path || ".");
+			let projectDir = this.projectDir || path.resolve(this.$options.path || ".");
 			let oldProjectFilePath = path.join(projectDir, ProjectData.OLD_PROJECT_FILE_NAME);
 			if(this.$fs.exists(oldProjectFilePath).wait()) {
 				this.upgrade(projectDir, oldProjectFilePath).wait();

lib/project-data.ts

@@ -1,4 +1,3 @@
-import options = require("./../common/options");
 import iOSProxyServices = require("./../common/mobile/ios/ios-proxy-services");
 import iOSDevice = require("./../common/mobile/ios/ios-device");
 import net = require("net");
@@ -8,12 +7,13 @@ class AndroidDebugService implements IDebugService {
 		private $platformService: IPlatformService,
 		private $platformsData: IPlatformsData,
 		private $projectData: IProjectData,
-		private $logger: ILogger) { }
+		private $logger: ILogger,
+		private $options: IOptions) { }
 
 	private get platform() { return "android"; }
 
 	public debug(): IFuture<void> {
-		return options.emulator
+		return this.$options.emulator
 			? this.debugOnEmulator()
 			: this.debugOnDevice();
 	}
@@ -31,19 +31,19 @@ class AndroidDebugService implements IDebugService {
 			var packageFile = "";
 			var platformData = this.$platformsData.getPlatformData(this.platform);
 
-			if (options["debug-brk"]) {
+			if (this.$options.debugBrk) {
 				this.$platformService.preparePlatform(this.platform).wait();
 
-				var cachedDeviceOption = options.forDevice;
-				options.forDevice = true;
+				var cachedDeviceOption = this.$options.forDevice;
+				this.$options.forDevice = true;
 				this.$platformService.buildPlatform(this.platform).wait();
-				options.forDevice = cachedDeviceOption;
+				this.$options.forDevice = cachedDeviceOption;
 
 				packageFile = this.$platformService.getLatestApplicationPackageForDevice(platformData).wait().packageName;
 				this.$logger.out("Using ", packageFile);
 			}
 
-			this.$devicesServices.initialize({ platform: this.platform, deviceId: options.device}).wait();
+			this.$devicesServices.initialize({ platform: this.platform, deviceId: this.$options.device}).wait();
 			var action = (device: Mobile.IAndroidDevice): IFuture<void> => { return device.debug(packageFile, this.$projectData.projectId) };
 			this.$devicesServices.execute(action).wait();
 

lib/services/android-debug-service.ts

@@ -4,9 +4,7 @@ import path = require("path");
 import shell = require("shelljs");
 import util = require("util");
 import Future = require("fibers/future");
-import options = require("../common/options");
 import constants = require("../constants");
-import hostInfo = require("../common/host-info");
 import helpers = require("../common/helpers");
 import fs = require("fs");
 import os = require("os");
@@ -26,7 +24,9 @@ class AndroidProjectService implements IPlatformProjectService {
 		private $fs: IFileSystem,
 		private $logger: ILogger,
 		private $projectData: IProjectData,
-		private $propertiesParser: IPropertiesParser) {
+		private $propertiesParser: IPropertiesParser,
+		private $options: IOptions,
+		private $hostInfo: IHostInfo) {
 	}
 
 	private _platformData: IPlatformData = null;
@@ -68,7 +68,7 @@ class AndroidProjectService implements IPlatformProjectService {
 			this.$fs.ensureDirectoryExists(projectRoot).wait();
 			var newTarget = this.getLatestValidAndroidTarget(frameworkDir).wait();
 			var versionNumber = _.last(newTarget.split("-"));
-			if(options.symlink) {
+			if(this.$options.symlink) {
 				this.copyResValues(projectRoot, frameworkDir, versionNumber).wait();
 				this.copy(projectRoot, frameworkDir, ".project AndroidManifest.xml project.properties custom_rules.xml", "-f").wait();
 
@@ -146,7 +146,7 @@ class AndroidProjectService implements IPlatformProjectService {
 
 	public buildProject(projectRoot: string): IFuture<void> {
 		return (() => {
-			var buildConfiguration = options.release ? "release" : "debug";
+			var buildConfiguration = this.$options.release ? "release" : "debug";
 			var args = this.getAntArgs(buildConfiguration, projectRoot);
 			this.spawn('ant', args).wait();
 		}).future<void>()();
@@ -256,7 +256,7 @@ class AndroidProjectService implements IPlatformProjectService {
 	}
 
 	private spawn(command: string, args: string[]): IFuture<void> {
-		if (hostInfo.isWindows()) {
+		if (this.$hostInfo.isWindows) {
 			args.unshift('/s', '/c', command);
 			command = process.env.COMSPEC || 'cmd.exe';
 		}
@@ -267,20 +267,20 @@ class AndroidProjectService implements IPlatformProjectService {
 	private getAntArgs(configuration: string, projectRoot: string): string[] {
 		var args = [configuration, "-f", path.join(projectRoot, "build.xml")];
 		if(configuration === "release") {
-			if(options.keyStorePath) {
-				args = args.concat(["-Dkey.store", options.keyStorePath]);
+			if(this.$options.keyStorePath) {
+				args = args.concat(["-Dkey.store", this.$options.keyStorePath]);
 			}
 
-			if(options.keyStorePassword) {
-				args = args.concat(["-Dkey.store.password", options.keyStorePassword]);
+			if(this.$options.keyStorePassword) {
+				args = args.concat(["-Dkey.store.password", this.$options.keyStorePassword]);
 			}
 
-			if(options.keyStoreAlias) {
-				args = args.concat(["-Dkey.alias", options.keyStoreAlias]);
+			if(this.$options.keyStoreAlias) {
+				args = args.concat(["-Dkey.alias", this.$options.keyStoreAlias]);
 			}
 
-			if(options.keyStoreAliasPassword) {
-				args = args.concat(["-Dkey.alias.password", options.keyStoreAliasPassword])
+			if(this.$options.keyStoreAliasPassword) {
+				args = args.concat(["-Dkey.alias.password", this.$options.keyStoreAliasPassword])
 			}
 		}