Merge pull request #10 from mflor35/refactor/pkg-mgr-replace

mflor35 · web-flow · commit 7f14263d0c63 · 2018-10-24T12:31:10.000-07:00
refactor() - [Yarn Support - Part 2] - Replace npm with package manag…
diff --git a/lib/bootstrap.ts b/lib/bootstrap.ts
@@ -79,7 +79,11 @@ $injector.require("itmsTransporterService", "./services/itmstransporter-service"
 $injector.requireCommand("setup|*", "./commands/setup");
 $injector.requireCommand(["setup|cloud", "cloud|setup"], "./commands/setup");
 
+$injector.requirePublic("packageManager", "./package-manager");
 $injector.requirePublic("npm", "./node-package-manager");
+$injector.requirePublic("yarn", "./yarn-package-manager");
+$injector.requireCommand("package-manager|set", "./commands/package-manager-set");
+
 $injector.require("npmInstallationManager", "./npm-installation-manager");
 $injector.require("dynamicHelpProvider", "./dynamic-help-provider");
 $injector.require("mobilePlatformsCapabilities", "./mobile-platforms-capabilities");
diff --git a/lib/commands/install.ts b/lib/commands/install.ts
@@ -13,7 +13,7 @@ export class InstallCommand implements ICommand {
 		private $logger: ILogger,
 		private $fs: IFileSystem,
 		private $stringParameter: ICommandParameter,
-		private $npm: INodePackageManager) {
+		private $packageManager: INodePackageManager) {
 		this.$projectData.initializeProjectData();
 	}
 
@@ -54,7 +54,7 @@ export class InstallCommand implements ICommand {
 			moduleName = devPrefix + moduleName;
 		}
 
-		await this.$npm.install(moduleName, projectDir, {
+		await this.$packageManager.install(moduleName, projectDir, {
 			'save-dev': true,
 			disableNpmInstall: this.$options.disableNpmInstall,
 			frameworkPath: this.$options.frameworkPath,
diff --git a/lib/commands/plugin/create-plugin.ts b/lib/commands/plugin/create-plugin.ts
@@ -13,7 +13,7 @@ export class CreatePluginCommand implements ICommand {
 		private $fs: IFileSystem,
 		private $childProcess: IChildProcess,
 		private $prompter: IPrompter,
-		private $npm: INodePackageManager) { }
+		private $packageManager: INodePackageManager) { }
 
 	public async execute(args: string[]): Promise<void> {
 		const pluginRepoName = args[0];
@@ -45,7 +45,7 @@ export class CreatePluginCommand implements ICommand {
 		try {
 			spinner.start();
 			const npmOptions: any = { silent: true };
-			await this.$npm.install(cwd, cwd, npmOptions);
+			await this.$packageManager.install(cwd, cwd, npmOptions);
 		} finally {
 			spinner.stop();
 		}
diff --git a/lib/commands/test-init.ts b/lib/commands/test-init.ts
@@ -12,7 +12,7 @@ class TestInitCommand implements ICommand {
 		mocha: ['chai']
 	};
 
-	constructor(private $npm: INodePackageManager,
+	constructor(private $packageManager: INodePackageManager,
 		private $projectData: IProjectData,
 		private $errors: IErrors,
 		private $options: IOptions,
@@ -55,7 +55,7 @@ class TestInitCommand implements ICommand {
 			if (mod.version) {
 				moduleToInstall += `@${mod.version}`;
 			}
-			await this.$npm.install(moduleToInstall, projectDir, {
+			await this.$packageManager.install(moduleToInstall, projectDir, {
 				'save-dev': true,
 				'save-exact': true,
 				optional: false,
@@ -76,7 +76,7 @@ class TestInitCommand implements ICommand {
 				// catch errors when a peerDependency is already installed
 				// e.g karma is installed; karma-jasmine depends on karma and will try to install it again
 				try {
-					await this.$npm.install(`${peerDependency}@${dependencyVersion}`, projectDir, {
+					await this.$packageManager.install(`${peerDependency}@${dependencyVersion}`, projectDir, {
 						'save-dev': true,
 						'save-exact': true,
 						disableNpmInstall: false,
diff --git a/lib/common/commands/package-manager-set.ts b/lib/common/commands/package-manager-set.ts
@@ -0,0 +1,20 @@
+
+export class PackageManagerCommand implements ICommand {
+
+	constructor(private $userSettingsService: IUserSettingsService,
+		private $errors: IErrors,
+		private $stringParameter: ICommandParameter) { }
+
+	public allowedParameters: ICommandParameter[] = [this.$stringParameter];
+
+	public execute(args: string[]): Promise<void> {
+		if (args[0] === 'yarn' ) {
+			return this.$userSettingsService.saveSetting("packageManager", "yarn");
+		} else if ( args[0] === 'npm') {
+			return this.$userSettingsService.saveSetting("packageManager", "npm");
+		}
+		return this.$errors.fail(`${args[0]} is not a valid package manager. Only yarn or npm are supported.`);
+	}
+}
+
+$injector.registerCommand("package-manager|set", PackageManagerCommand);
diff --git a/lib/services/android-plugin-build-service.ts b/lib/services/android-plugin-build-service.ts
@@ -22,7 +22,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		private $hostInfo: IHostInfo,
 		private $androidToolsInfo: IAndroidToolsInfo,
 		private $logger: ILogger,
-		private $npm: INodePackageManager,
+		private $packageManager: INodePackageManager,
 		private $projectDataService: IProjectDataService,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $errors: IErrors,
@@ -295,7 +295,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 	}
 
 	private async getRuntimeGradleVersions(projectDir: string): Promise<IRuntimeGradleVersions> {
-		const registryData = await this.$npm.getRegistryPackageData(TNS_ANDROID_RUNTIME_NAME);
+		const registryData = await this.$packageManager.getRegistryPackageData(TNS_ANDROID_RUNTIME_NAME);
 		let runtimeGradleVersions: IRuntimeGradleVersions = null;
 		if (projectDir) {
 			const projectRuntimeVersion = this.$platformService.getCurrentPlatformVersion(
diff --git a/lib/services/android-project-service.ts b/lib/services/android-project-service.ts
@@ -27,7 +27,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		private $injector: IInjector,
 		private $pluginVariablesService: IPluginVariablesService,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
-		private $npm: INodePackageManager,
+		private $packageManager: INodePackageManager,
 		private $androidPluginBuildService: IAndroidPluginBuildService,
 		private $platformEnvironmentRequirements: IPlatformEnvironmentRequirements,
 		private $androidResourcesMigrationService: IAndroidResourcesMigrationService,
@@ -206,7 +206,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 				(projectPackageJson.devDependencies && projectPackageJson.devDependencies[dependency.name]);
 
 			if (!dependencyVersionInProject) {
-				await this.$npm.install(`${dependency.name}@${dependency.version}`, projectData.projectDir, npmConfig);
+				await this.$packageManager.install(`${dependency.name}@${dependency.version}`, projectData.projectDir, npmConfig);
 			} else {
 				const cleanedVersion = semver.clean(dependencyVersionInProject);
 
diff --git a/lib/services/init-service.ts b/lib/services/init-service.ts
@@ -21,7 +21,7 @@ export class InitService implements IInitService {
 		private $staticConfig: IStaticConfig,
 		private $projectHelper: IProjectHelper,
 		private $prompter: IPrompter,
-		private $npm: INodePackageManager,
+		private $packageManager: INodePackageManager,
 		private $npmInstallationManager: INpmInstallationManager) { }
 
 	public async initialize(): Promise<void> {
@@ -106,7 +106,7 @@ export class InitService implements IInitService {
 			return this.buildVersionData(latestVersion);
 		}
 
-		const allVersions: any = await this.$npm.view(packageName, { "versions": true });
+		const allVersions: any = await this.$packageManager.view(packageName, { "versions": true });
 		const versions = _.filter(allVersions, (version: string) => semver.gte(version, InitService.MIN_SUPPORTED_FRAMEWORK_VERSIONS[packageName]));
 		if (versions.length === 1) {
 			this.$logger.info(`Only ${versions[0]} version is available for ${packageName}.`);
diff --git a/lib/services/plugins-service.ts b/lib/services/plugins-service.ts
@@ -31,7 +31,7 @@ export class PluginsService implements IPluginsService {
 		}, PluginsService.NPM_CONFIG);
 	}
 
-	constructor(private $npm: INodePackageManager,
+	constructor(private $packageManager: INodePackageManager,
 		private $fs: IFileSystem,
 		private $options: IOptions,
 		private $logger: ILogger,
@@ -46,7 +46,7 @@ export class PluginsService implements IPluginsService {
 			plugin = possiblePackageName;
 		}
 
-		const name = (await this.$npm.install(plugin, projectData.projectDir, this.npmInstallOptions)).name;
+		const name = (await this.$packageManager.install(plugin, projectData.projectDir, this.npmInstallOptions)).name;
 		const pathToRealNpmPackageJson = path.join(projectData.projectDir, "node_modules", name, "package.json");
 		const realNpmPackageJson = this.$fs.readJson(pathToRealNpmPackageJson);
 
@@ -65,14 +65,14 @@ export class PluginsService implements IPluginsService {
 			} catch (err) {
 				// Revert package.json
 				this.$projectDataService.removeNSProperty(projectData.projectDir, this.$pluginVariablesService.getPluginVariablePropertyName(pluginData.name));
-				await this.$npm.uninstall(plugin, PluginsService.NPM_CONFIG, projectData.projectDir);
+				await this.$packageManager.uninstall(plugin, PluginsService.NPM_CONFIG, projectData.projectDir);
 
 				throw err;
 			}
 
 			this.$logger.out(`Successfully installed plugin ${realNpmPackageJson.name}.`);
 		} else {
-			await this.$npm.uninstall(realNpmPackageJson.name, { save: true }, projectData.projectDir);
+			await this.$packageManager.uninstall(realNpmPackageJson.name, { save: true }, projectData.projectDir);
 			this.$errors.failWithoutHelp(`${plugin} is not a valid NativeScript plugin. Verify that the plugin package.json file contains a nativescript key and try again.`);
 		}
 	}
@@ -181,7 +181,7 @@ export class PluginsService implements IPluginsService {
 		const notInstalledDependencies = _.difference(allDependencies, installedDependencies);
 		if (this.$options.force || notInstalledDependencies.length) {
 			this.$logger.trace("Npm install will be called from CLI. Force option is: ", this.$options.force, " Not installed dependencies are: ", notInstalledDependencies);
-			await this.$npm.install(projectData.projectDir, projectData.projectDir, {
+			await this.$packageManager.install(projectData.projectDir, projectData.projectDir, {
 				disableNpmInstall: this.$options.disableNpmInstall,
 				frameworkPath: this.$options.frameworkPath,
 				ignoreScripts: this.$options.ignoreScripts,
@@ -282,9 +282,9 @@ export class PluginsService implements IPluginsService {
 
 	private async executeNpmCommand(npmCommandName: string, npmCommandArguments: string, projectData: IProjectData): Promise<string> {
 		if (npmCommandName === PluginsService.INSTALL_COMMAND_NAME) {
-			await this.$npm.install(npmCommandArguments, projectData.projectDir, this.npmInstallOptions);
+			await this.$packageManager.install(npmCommandArguments, projectData.projectDir, this.npmInstallOptions);
 		} else if (npmCommandName === PluginsService.UNINSTALL_COMMAND_NAME) {
-			await this.$npm.uninstall(npmCommandArguments, PluginsService.NPM_CONFIG, projectData.projectDir);
+			await this.$packageManager.uninstall(npmCommandArguments, PluginsService.NPM_CONFIG, projectData.projectDir);
 		}
 
 		return this.parseNpmCommandResult(npmCommandArguments);
diff --git a/lib/services/prepare-platform-js-service.ts b/lib/services/prepare-platform-js-service.ts
@@ -16,7 +16,7 @@ export class PreparePlatformJSService extends PreparePlatformService implements
 		private $logger: ILogger,
 		private $projectDataService: IProjectDataService,
 		private $nodeModulesBuilder: INodeModulesBuilder,
-		private $npm: INodePackageManager) {
+		private $packageManager: INodePackageManager) {
 		super($fs, $hooksService, $xmlValidator);
 	}
 
@@ -77,7 +77,7 @@ export class PreparePlatformJSService extends PreparePlatformService implements
 			const tempDir = temp.mkdirSync("platform-template");
 			this.$fs.writeJson(path.join(tempDir, constants.PACKAGE_JSON_FILE_NAME), {});
 			try {
-				const npmInstallResult = await this.$npm.install(selectedTemplate, tempDir, {
+				const npmInstallResult = await this.$packageManager.install(selectedTemplate, tempDir, {
 					disableNpmInstall: false,
 					frameworkPath: null,
 					ignoreScripts: false
diff --git a/lib/services/project-service.ts b/lib/services/project-service.ts
@@ -9,7 +9,7 @@ import * as temp from "temp";
 export class ProjectService implements IProjectService {
 
 	constructor(private $hooksService: IHooksService,
-		private $npm: INodePackageManager,
+		private $packageManager: INodePackageManager,
 		private $errors: IErrors,
 		private $fs: IFileSystem,
 		private $logger: ILogger,
@@ -99,11 +99,11 @@ export class ProjectService implements IProjectService {
 			}
 
 			if (templateVersion === constants.TemplateVersions.v1) {
-				await this.$npm.uninstall(templatePackageJsonContent.name, { save: true }, projectDir);
+				await this.$packageManager.uninstall(templatePackageJsonContent.name, { save: true }, projectDir);
 			}
 
 			// Install devDependencies and execute all scripts:
-			await this.$npm.install(projectDir, projectDir, {
+			await this.$packageManager.install(projectDir, projectDir, {
 				disableNpmInstall: false,
 				frameworkPath: null,
 				ignoreScripts
diff --git a/lib/services/user-settings-service.ts b/lib/services/user-settings-service.ts
@@ -1,7 +1,7 @@
 import * as path from "path";
 import * as userSettingsServiceBaseLib from "../common/services/user-settings-service";
 
-class UserSettingsService extends userSettingsServiceBaseLib.UserSettingsServiceBase {
+export class UserSettingsService extends userSettingsServiceBaseLib.UserSettingsServiceBase {
 	constructor($fs: IFileSystem,
 		$settingsService: ISettingsService,
 		$lockfile: ILockFile,
diff --git a/test/debug.ts b/test/debug.ts
@@ -52,7 +52,7 @@ function createTestInjector(): IInjector {
 	testInjector.register("projectTemplatesService", {});
 	testInjector.register("debugService", {});
 	testInjector.register("xmlValidator", {});
-	testInjector.register("npm", {});
+	testInjector.register("packageManager", {});
 	testInjector.register("debugDataService", {
 		createDebugData: () => ({})
 	});
diff --git a/test/ios-project-service.ts b/test/ios-project-service.ts
@@ -27,7 +27,9 @@ import { PluginsService } from "../lib/services/plugins-service";
 import { PluginVariablesHelper } from "../lib/common/plugin-variables-helper";
 import { Utils } from "../lib/common/utils";
 import { CocoaPodsService } from "../lib/services/cocoapods-service";
+import { PackageManager } from "../lib/package-manager";
 import { NodePackageManager } from "../lib/node-package-manager";
+import { YarnPackageManager } from "../lib/yarn-package-manager";
 
 import { assert } from "chai";
 import { IOSProvisionService } from "../lib/services/ios-provision-service";
@@ -115,7 +117,12 @@ function createTestInjector(projectPath: string, projectName: string, xcode?: IX
 			pbxGroupByName() { /* */ }
 		}
 	});
+	testInjector.register("userSettingsService", {
+		getSettingValue: async (settingName: string): Promise<void> => undefined
+	});
+	testInjector.register("packageManager", PackageManager);
 	testInjector.register("npm", NodePackageManager);
+	testInjector.register("yarn", YarnPackageManager);
 	testInjector.register("xCConfigService", XCConfigService);
 	testInjector.register("settingsService", SettingsService);
 	testInjector.register("httpClient", {});
@@ -130,7 +137,9 @@ function createTestInjector(projectPath: string, projectName: string, xcode?: IX
 		hasChangesInShasums: (oldPluginNativeHashes: IStringDictionary, currentPluginNativeHashes: IStringDictionary) => true,
 		generateHashes: async (files: string[]): Promise<IStringDictionary> => ({})
 	});
-
+	testInjector.register("pacoteService", {
+		extractPackage: async (packageName: string, destinationDirectory: string, options?: IPacoteExtractOptions): Promise<void> => undefined
+	});
 	return testInjector;
 }
 
diff --git a/test/nativescript-cli-lib.ts b/test/nativescript-cli-lib.ts
@@ -27,7 +27,7 @@ describe("nativescript-cli-lib", () => {
 		constants: ["CONFIG_NS_APP_RESOURCES_ENTRY", "CONFIG_NS_APP_ENTRY", "CONFIG_NS_FILE_NAME"],
 		localBuildService: ["build"],
 		deviceLogProvider: null,
-		npm: ["install", "uninstall", "view", "search"],
+		packageManager: ["install", "uninstall", "view", "search"],
 		extensibilityService: ["loadExtensions", "loadExtension", "getInstalledExtensions", "installExtension", "uninstallExtension"],
 		liveSyncService: ["liveSync", "stopLiveSync", "enableDebugging", "disableDebugging", "attachDebugger"],
 		debugService: ["debug"],
diff --git a/test/npm-support.ts b/test/npm-support.ts
@@ -2,6 +2,8 @@ import yok = require('../lib/common/yok');
 import stubs = require('./stubs');
 import ErrorsLib = require("../lib/common/errors");
 import NpmLib = require("../lib/node-package-manager");
+import PackageManagerLib = require("../lib/package-manager");
+import YarnLib = require("../lib/yarn-package-manager");
 import FsLib = require("../lib/common/file-system");
 import OptionsLib = require("../lib/options");
 import StaticConfigLib = require("../lib/config");
@@ -65,7 +67,12 @@ function createTestInjector(): IInjector {
 	testInjector.register("hooksService", stubs.HooksServiceStub);
 	testInjector.register("nodeModulesBuilder", NodeModulesLib.NodeModulesBuilder);
 	testInjector.register("pluginsService", PluginsServiceLib.PluginsService);
+	testInjector.register("userSettingsService", {
+		getSettingValue: async (settingName: string): Promise<void> => undefined
+	});
 	testInjector.register("npm", NpmLib.NodePackageManager);
+	testInjector.register("packageManager", PackageManagerLib.PackageManager);
+	testInjector.register("yarn", YarnLib.YarnPackageManager);
 	testInjector.register("childProcess", ChildProcessLib.ChildProcess);
 	testInjector.register("projectFilesManager", ProjectFilesManagerLib.ProjectFilesManager);
 	testInjector.register("commandsServiceProvider", {
diff --git a/test/platform-service.ts b/test/platform-service.ts
@@ -84,7 +84,7 @@ function createTestInjector() {
 	testInjector.register("xmlValidator", XmlValidator);
 	testInjector.register("preparePlatformNativeService", PreparePlatformNativeService);
 	testInjector.register("preparePlatformJSService", PreparePlatformJSService);
-	testInjector.register("npm", {
+	testInjector.register("packageManager", {
 		uninstall: async () => {
 			return true;
 		}
diff --git a/test/plugin-create.ts b/test/plugin-create.ts
@@ -24,7 +24,7 @@ function createTestInjector() {
 	testInjector.register("childProcess", stubs.ChildProcessStub);
 	testInjector.register("prompter", new stubs.PrompterStub());
 	testInjector.register("fs", stubs.FileSystemStub);
-	testInjector.register("npm", stubs.NpmInstallationManagerStub);
+	testInjector.register("packageManager", stubs.NpmInstallationManagerStub);
 	testInjector.register("options", {
 		username: undefined,
 		pluginName: undefined,
diff --git a/test/plugins-service.ts b/test/plugins-service.ts
@@ -1,7 +1,9 @@
 import { Yok } from '../lib/common/yok';
 import * as stubs from './stubs';
-import { NodePackageManager } from "../lib/node-package-manager";
+import { PackageManager } from "../lib/package-manager";
 import { NpmInstallationManager } from "../lib/npm-installation-manager";
+import { NodePackageManager } from "../lib/node-package-manager";
+import { YarnPackageManager } from "../lib/yarn-package-manager";
 import { FileSystem } from "../lib/common/file-system";
 import { ProjectData } from "../lib/project-data";
 import { ChildProcess } from "../lib/common/child-process";
@@ -42,7 +44,12 @@ let isErrorThrown = false;
 function createTestInjector() {
 	const testInjector = new Yok();
 	testInjector.register("messagesService", MessagesService);
+	testInjector.register("userSettingsService", {
+		getSettingValue: async (settingName: string): Promise<void> => undefined
+	});
+	testInjector.register("packageManager", PackageManager);
 	testInjector.register("npm", NodePackageManager);
+	testInjector.register("yarn", YarnPackageManager);
 	testInjector.register("fs", FileSystem);
 	testInjector.register("adb", {});
 	testInjector.register("androidDebugBridgeResultHandler", {});
@@ -124,6 +131,9 @@ function createTestInjector() {
 		hasChangesInShasums: (oldPluginNativeHashes: IStringDictionary, currentPluginNativeHashes: IStringDictionary) => true,
 		generateHashes: async (files: string[]): Promise<IStringDictionary> => ({})
 	});
+	testInjector.register("pacoteService", {
+		extractPackage: async (packageName: string, destinationDirectory: string, options?: IPacoteExtractOptions): Promise<void> => undefined
+	});
 	return testInjector;
 }
 
@@ -597,7 +607,7 @@ describe("Plugins service", () => {
 				enumerateFilesInDirectorySync: (): string[] => ["some_file"]
 			});
 
-			unitTestsInjector.register("npm", {});
+			unitTestsInjector.register("packageManager", {});
 			unitTestsInjector.register("options", {});
 			unitTestsInjector.register("logger", {});
 			unitTestsInjector.register("errors", {});
diff --git a/test/project-service.ts b/test/project-service.ts
diff --git a/test/services/android-plugin-build-service.ts b/test/services/android-plugin-build-service.ts
diff --git a/test/services/pacote-service.ts b/test/services/pacote-service.ts
