refactor: manager-agnostic view/search and resolution-based package lookups

view() now takes an optional registry field instead of an npm flag bag, and
search() takes only the keywords; each package manager spells the field
selection itself (yarn berry uses --fields). The generic npm flag-string
builder is gone with them, so nothing in the package manager layer emits
npm syntax on behalf of another manager any more.

Project-facing package lookups go through Node resolution from the project
directory instead of joining node_modules/<name> by hand: test-init peer
dependency discovery, the installed path returned by
PackageInstallationManager, the local inspector check, the core modules
short-import scan in doctor, and the installed core modules versions in
versions-service. plugins-service no longer creates an empty node_modules
directory before enumerating dependencies.

Author: rigor789

PublicAPI.md

@@ -556,16 +556,15 @@ Searches for a package using keywords.
 ```TypeScript
 /**
  * Searches for a package.
- * @param  {string[]}                            filter Keywords with which to perform the search.
- * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate search.
- * @return {Promise<string>}                The output of the uninstallation.
+ * @param  {string[]} filter Keywords with which to perform the search.
+ * @return {Promise<string>} The raw search output.
  */
-search(filter: string[], config: IDictionary<string | boolean>): Promise<string>;
+search(filter: string[]): Promise<string>;
 ```
 
 * Usage:
 ```JavaScript
-tns.npm.search(["nativescript", "cloud"], { silent: true }).then(output => {
+tns.npm.search(["nativescript", "cloud"]).then(output => {
 	console.log(`Found: ${output}`);
 }, err => {
 	console.log("An error occurred during searching", err);
@@ -578,17 +577,17 @@ Provides information about a given package.
 * Definition
 ```TypeScript
 /**
- * Provides information about a given package.
- * @param  {string}                            packageName The name of the package.
- * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate view.
- * @return {Promise<any>}                Object, containing information about the package.
+ * Provides registry information about a package.
+ * @param  {string} packageName The name of the package, optionally with a version.
+ * @param  {string} field       Optional single registry field (e.g. "versions" or "dist-tags") to return instead of the whole document.
+ * @return {Promise<any>} The parsed registry data.
  */
-view(packageName: string, config: Object): Promise<any>;
+view(packageName: string, field?: string): Promise<any>;
 ```
 
 * Usage:
 ```JavaScript
-tns.npm.view(["nativescript"], {}).then(result => {
+tns.npm.view("nativescript").then(result => {
 	console.log(`${result.name}'s latest version is ${result["dist-tags"].latest}`);
 }, err => {
 	console.log("An error occurred during viewing", err);

lib/commands/test-init.ts

@@ -2,6 +2,7 @@ import * as path from "path";
 import * as _ from "lodash";
 import { TESTING_FRAMEWORKS, ProjectTypes } from "../constants";
 import { fromWindowsRelativePathToUnix } from "../common/helpers";
+import { resolvePackageJSONPath } from "../helpers/package-path-helper";
 import {
 	IProjectData,
 	ITestInitializationService,
@@ -137,9 +138,9 @@ export class TestInitCommand extends Command({
 				path: this.$options.path,
 			});
 
-			const modulePath = path.join(projectDir, "node_modules", mod.name);
-			const modulePackageJsonPath = path.join(modulePath, "package.json");
-			const modulePackageJsonContent = this.$fs.readJson(modulePackageJsonPath);
+			const modulePackageJsonContent = this.$fs.readJson(
+				resolvePackageJSONPath(mod.name, { paths: [projectDir] }),
+			);
 			const modulePeerDependencies =
 				modulePackageJsonContent.peerDependencies || {};
 			const modulePeerDependenciesMeta =

lib/contracts/package-manager.ts

@@ -1,5 +1,4 @@
 import { Contract } from "../common/di/contract";
-import type { IDictionary } from "../common/declarations";
 import type {
 	IPackageInstallOptions,
 	IPackageUninstallOptions,
@@ -42,11 +41,11 @@ export abstract class PackageManager {
 
 	/**
 	 * Provides information about a given package.
-	 * @param  {string}                            packageName The name of the package.
-	 * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate view.
-	 * @return {Promise<any>}                Object, containing information about the package.
+	 * @param  {string} packageName The name of the package, optionally with a version.
+	 * @param  {string} field       @optional A single registry field (e.g. "versions" or "dist-tags") to return instead of the whole document.
+	 * @return {Promise<any>} The parsed registry data, or null when it cannot be parsed.
 	 */
-	abstract view(packageName: string, config: Object): Promise<any>;
+	abstract view(packageName: string, field?: string): Promise<any>;
 
 	/**
 	 * Checks if the specified string is name of a packaged published in the NPM registry.
@@ -75,14 +74,10 @@ export abstract class PackageManager {
 
 	/**
 	 * Searches for a package.
-	 * @param  {string[]}                            filter Keywords with which to perform the search.
-	 * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate search.
-	 * @return {Promise<string>}                The output of the uninstallation.
+	 * @param  {string[]} filter Keywords with which to perform the search.
+	 * @return {Promise<string>} The raw search output.
 	 */
-	abstract search(
-		filter: string[],
-		config: IDictionary<string | boolean>,
-	): Promise<string>;
+	abstract search(filter: string[]): Promise<string>;
 
 	/**
 	 * Searches for npm packages in npms by keyword.

lib/declarations.d.ts

@@ -55,7 +55,13 @@ interface INodePackageManager {
 	 * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate view.
 	 * @return {Promise<any>}                Object, containing information about the package.
 	 */
-	view(packageName: string, config: Object): Promise<any>;
+	/**
+	 * Provides registry information about a package.
+	 * @param  {string} packageName The name of the package, optionally with a version.
+	 * @param  {string} field       @optional A single registry field (e.g. "versions" or "dist-tags") to return instead of the whole document.
+	 * @return {Promise<any>} The parsed registry data, or null when it cannot be parsed.
+	 */
+	view(packageName: string, field?: string): Promise<any>;
 
 	/**
 	 * Checks if the specified string is name of a packaged published in the NPM registry.
@@ -84,10 +90,7 @@ interface INodePackageManager {
 	 * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate search.
 	 * @return {Promise<string>}                The output of the uninstallation.
 	 */
-	search(
-		filter: string[],
-		config: IDictionary<string | boolean>,
-	): Promise<string>;
+	search(filter: string[]): Promise<string>;
 
 	/**
 	 * Searches for npm packages in npms by keyword.

lib/package-managers/base-package-manager.ts

@@ -7,12 +7,7 @@ import {
 	INpmsResult,
 	INpmPackageNameParts,
 } from "../declarations";
-import {
-	IDictionary,
-	IChildProcess,
-	IFileSystem,
-	IHostInfo,
-} from "../common/declarations";
+import { IChildProcess, IFileSystem, IHostInfo } from "../common/declarations";
 
 /**
  * How one package manager spells each IPackageInstallOptions flag on its
@@ -43,11 +38,8 @@ export abstract class BasePackageManager implements INodePackageManager {
 		options?: IPackageUninstallOptions,
 		path?: string,
 	): Promise<string>;
-	public abstract view(packageName: string, config: Object): Promise<any>;
-	public abstract search(
-		filter: string[],
-		config: IDictionary<string | boolean>,
-	): Promise<string>;
+	public abstract view(packageName: string, field?: string): Promise<any>;
+	public abstract search(filter: string[]): Promise<string>;
 	public abstract searchNpms(keyword: string): Promise<INpmsResult>;
 	public abstract getRegistryPackageData(packageName: string): Promise<any>;
 	public abstract getCachePath(): Promise<string>;
@@ -70,7 +62,7 @@ export abstract class BasePackageManager implements INodePackageManager {
 		}
 
 		try {
-			const viewResult = await this.view(packageName, { name: true });
+			const viewResult = await this.view(packageName, "name");
 
 			// `npm view nonExistingPackageName` will return `nativescript`
 			// if executed in the root dir of the CLI (npm 6.4.1)
@@ -183,41 +175,6 @@ export abstract class BasePackageManager implements INodePackageManager {
 		return result;
 	}
 
-	protected getFlagsString(config: any, asArray: boolean): any {
-		const array: Array<string> = [];
-		for (const flag in config) {
-			if (
-				flag === "global" &&
-				this.packageManager !== "yarn" &&
-				this.packageManager !== "yarn2"
-			) {
-				array.push(`--${flag}`);
-				array.push(`${config[flag]}`);
-			} else if (config[flag]) {
-				if (
-					flag === "dist-tags" ||
-					flag === "versions" ||
-					flag === "name" ||
-					flag === "gradle" ||
-					flag === "version_info"
-				) {
-					if (this.packageManager === "yarn2") {
-						array.push(`--fields ${flag}`);
-					} else {
-						array.push(` ${flag}`);
-					}
-					continue;
-				}
-				array.push(`--${flag}`);
-			}
-		}
-		if (asArray) {
-			return array;
-		}
-
-		return array.join(" ");
-	}
-
 	private isTgz(packageName: string): boolean {
 		return packageName.indexOf(".tgz") >= 0;
 	}

lib/package-managers/bun.ts

@@ -94,17 +94,13 @@ export class BunPackageManager extends BasePackageManager {
 		});
 	}
 
-	// Bun does not have a `view` command; use npm.
 	@exported("bun")
-	public async view(packageName: string, config: Object): Promise<any> {
-		const wrappedConfig = _.extend({}, config, { json: true }); // always require view response as JSON
-
-		const flags = this.getFlagsString(wrappedConfig, false);
+	// Bun does not have a `view` command; use npm.
+	public async view(packageName: string, field?: string): Promise<any> {
+		const args = [packageName, field, "--json"].filter(Boolean).join(" ");
 		let viewResult: any;
 		try {
-			viewResult = await this.$childProcess.exec(
-				`npm view ${packageName} ${flags}`
-			);
+			viewResult = await this.$childProcess.exec(`npm view ${args}`);
 		} catch (e) {
 			this.$errors.fail(e.message);
 		}
@@ -116,11 +112,10 @@ export class BunPackageManager extends BasePackageManager {
 		}
 	}
 
-	// Bun does not have a `search` command; use npm.
 	@exported("bun")
-	public async search(filter: string[], config: any): Promise<string> {
-		const flags = this.getFlagsString(config, false);
-		return this.$childProcess.exec(`npm search ${filter.join(" ")} ${flags}`);
+	// Bun does not have a `search` command; use npm.
+	public async search(filter: string[]): Promise<string> {
+		return this.$childProcess.exec(`npm search ${filter.join(" ")}`);
 	}
 
 	public async searchNpms(keyword: string): Promise<INpmsResult> {

lib/package-managers/index.ts

@@ -14,7 +14,6 @@ import {
 import {
 	IErrors,
 	IUserSettingsService,
-	IDictionary,
 } from "../common/declarations";
 import { injector } from "../common/yok";
 import { IProjectConfigService } from "../definitions/project";
@@ -66,16 +65,13 @@ export class PackageManager implements IPackageManager {
 	}
 	@exported("packageManager")
 	@invokeInit()
-	public view(packageName: string, config: Object): Promise<any> {
-		return this.packageManager.view(packageName, config);
+	public view(packageName: string, field?: string): Promise<any> {
+		return this.packageManager.view(packageName, field);
 	}
 	@exported("packageManager")
 	@invokeInit()
-	public search(
-		filter: string[],
-		config: IDictionary<string | boolean>
-	): Promise<string> {
-		return this.packageManager.search(filter, config);
+	public search(filter: string[]): Promise<string> {
+		return this.packageManager.search(filter);
 	}
 
 	@invokeInit()
@@ -122,7 +118,7 @@ export class PackageManager implements IPackageManager {
 		}
 
 		try {
-			const result = await this.view(packageName, { "dist-tags": true });
+			const result = await this.view(packageName, "dist-tags");
 			version = result[tag];
 		} catch (err) {
 			this.$logger.trace(

lib/package-managers/npm.ts

@@ -125,21 +125,16 @@ export class NpmPackageManager extends BasePackageManager {
 	}
 
 	@exported("npm")
-	public async search(filter: string[], config: any): Promise<string> {
-		const flags = this.getFlagsString(config, false);
-		return this.$childProcess.exec(`npm search ${filter.join(" ")} ${flags}`);
+	public async search(filter: string[]): Promise<string> {
+		return this.$childProcess.exec(`npm search ${filter.join(" ")}`);
 	}
 
 	@exported("npm")
-	public async view(packageName: string, config: Object): Promise<any> {
-		const wrappedConfig = _.extend({}, config, { json: true }); // always require view response as JSON
-
-		const flags = this.getFlagsString(wrappedConfig, false);
+	public async view(packageName: string, field?: string): Promise<any> {
+		const args = [packageName, field, "--json"].filter(Boolean).join(" ");
 		let viewResult: any;
 		try {
-			viewResult = await this.$childProcess.exec(
-				`npm view ${packageName} ${flags}`
-			);
+			viewResult = await this.$childProcess.exec(`npm view ${args}`);
 		} catch (e) {
 			this.$errors.fail(e.message);
 		}

lib/package-managers/package-installation-manager.ts

@@ -1,5 +1,6 @@
 import * as path from "path";
 import * as constants from "../constants";
+import { resolvePackagePath } from "../helpers/package-path-helper";
 import {
 	INpmInstallOptions,
 	INpmInstallResultInfo,
@@ -67,9 +68,7 @@ export class PackageInstallationManager implements IPackageInstallationManager {
 		packageName: string,
 		versionRange: string
 	): Promise<string> {
-		const data = await this.$packageManager.view(packageName, {
-			versions: true,
-		});
+		const data = await this.$packageManager.view(packageName, "versions");
 
 		let versions;
 
@@ -190,14 +189,11 @@ export class PackageInstallationManager implements IPackageInstallationManager {
 		inspectorNpmPackageName: string,
 		projectDir: string
 	): Promise<string> {
-		const inspectorPath = path.join(
-			projectDir,
-			constants.NODE_MODULES_FOLDER_NAME,
-			inspectorNpmPackageName
-		);
-
 		// local installation takes precedence over cache
-		if (this.inspectorAlreadyInstalled(inspectorPath)) {
+		const inspectorPath = resolvePackagePath(inspectorNpmPackageName, {
+			paths: [projectDir],
+		});
+		if (inspectorPath) {
 			return inspectorPath;
 		}
 
@@ -266,14 +262,6 @@ export class PackageInstallationManager implements IPackageInstallationManager {
 		}
 	}
 
-	private inspectorAlreadyInstalled(pathToInspector: string): Boolean {
-		if (this.$fs.exists(pathToInspector)) {
-			return true;
-		}
-
-		return false;
-	}
-
 	private async installCore(
 		packageName: string,
 		pathToSave: string,
@@ -293,15 +281,7 @@ export class PackageInstallationManager implements IPackageInstallationManager {
 			version,
 			dev
 		);
-		const installedPackageName = installResultInfo.name;
-
-		const pathToInstalledPackage = path.join(
-			pathToSave,
-			"node_modules",
-			installedPackageName
-		);
-
-		return pathToInstalledPackage;
+		return resolvePackagePath(installResultInfo.name, { paths: [pathToSave] });
 	}
 
 	private async npmInstall(
@@ -335,9 +315,7 @@ export class PackageInstallationManager implements IPackageInstallationManager {
 		packageName: string,
 		version: string
 	): Promise<string> {
-		let data: any = await this.$packageManager.view(packageName, {
-			"dist-tags": true,
-		});
+		let data: any = await this.$packageManager.view(packageName, "dist-tags");
 		data = data?.["dist-tags"] ?? data;
 		this.$logger.trace("Using version %s. ", data[version]);