refactor: type package manager install and uninstall options

Replace the untyped npm flag bag passed to install/uninstall with
IPackageInstallOptions and IPackageUninstallOptions (save, dev, optional,
exact, silent, ignoreScripts plus the CLI-internal options). Each package
manager declares how it spells each option, and options a manager has no
flag for are dropped instead of leaking npm syntax onto its command line.

This fixes yarn berry receiving --save-dev / --save-exact (silently
dropped, so platforms landed in dependencies) and --ignore-scripts (an
unknown option that aborted the install); it now gets --dev, --exact and
--mode=skip-build. bun receives its own --dev / --exact instead of npm's.

Also settle the implementation class names on NpmPackageManager,
YarnPackageManager, Yarn2PackageManager, PnpmPackageManager and
BunPackageManager.

Author: rigor789

PublicAPI.md

@@ -479,7 +479,7 @@ tns.settingsService.setSettings({ userAgentName: "myUserAgent", profileDir: "cus
 `npm` module provides a way to interact with npm specifically the use of install, uninstall, search and view commands.
 
 ### install
-Installs specified package. Note that you can use the third argument in order to pass different options to the installation like `ignore-scripts`, `save` or `save-exact` which work exactly like they would if you would execute npm from the command line and pass them as `--` flags.
+Installs specified package. The third argument takes package-manager-agnostic options (`dev`, `exact`, `save`, `optional`, `silent`, `ignoreScripts`); the selected package manager maps them onto its own command line flags.
 * Auxiliary interfaces:
 ```TypeScript
 /**
@@ -533,11 +533,11 @@ Uninstalls a specified package.
 /**
  * Uninstalls a dependency
  * @param  {string}                            packageName The name of the dependency.
- * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate  uninstallation.
+ * @param  {IPackageUninstallOptions}          options     Package-manager-agnostic uninstallation options (`save`).
  * @param  {string}                            path  The destination of the uninstallation.
  * @return {Promise<any>}                The output of the uninstallation.
 */
-uninstall(packageName: string, config?: IDictionary<string | boolean>, path?: string): Promise<string>;
+uninstall(packageName: string, options?: IPackageUninstallOptions, path?: string): Promise<string>;
 ```
 
 * Usage:

lib/commands/install.ts

@@ -95,7 +95,7 @@ async function installModule(
 	}
 
 	await $packageManager.install(moduleName, projectDir, {
-		"save-dev": true,
+		dev: true,
 		disableNpmInstall: context.options.disableNpmInstall,
 		frameworkPath: context.options.frameworkPath,
 		ignoreScripts: context.options.ignoreScripts,

lib/commands/plugin/create-plugin.ts

@@ -180,8 +180,7 @@ export class CreatePluginCommand extends Command({
 		const cwd = path.join(projectDir, "src");
 		try {
 			spinner.start();
-			const npmOptions: any = { silent: true };
-			await this.$packageManager.install(cwd, cwd, npmOptions);
+			await this.$packageManager.install(cwd, cwd, { silent: true });
 		} finally {
 			spinner.stop();
 		}

lib/commands/preview.ts

@@ -53,9 +53,9 @@ export class PreviewCommand extends Command({
 			`${PREVIEW_CLI_PACKAGE}@latest`,
 			this.$projectData.projectDir,
 			{
-				"save-dev": true,
-				"save-exact": true,
-			} as any,
+				dev: true,
+				exact: true,
+			},
 		);
 	}
 

lib/commands/test-init.ts

@@ -129,9 +129,8 @@ export class TestInitCommand extends Command({
 			await this.$packageManager.install(moduleToInstall, projectDir, {
 				// Packages with native code must land in "dependencies" — the CLI
 				// integrates plugin platform files (pods, aars) only from there.
-				...(mod.saveInDependencies ? { save: true } : { "save-dev": true }),
-				"save-exact": true,
-				optional: false,
+				dev: !mod.saveInDependencies,
+				exact: true,
 				disableNpmInstall: this.$options.disableNpmInstall,
 				frameworkPath: this.$options.frameworkPath,
 				ignoreScripts: this.$options.ignoreScripts,
@@ -186,8 +185,8 @@ export class TestInitCommand extends Command({
 						`${peerDependency}@${dependencyVersion}`,
 						projectDir,
 						{
-							"save-dev": true,
-							"save-exact": true,
+							dev: true,
+							exact: true,
 							disableNpmInstall: false,
 							frameworkPath: this.$options.frameworkPath,
 							ignoreScripts: this.$options.ignoreScripts,

lib/constants.ts

@@ -126,13 +126,6 @@ export const TemplatesV2PackageJsonKeysToRemove: Array<String> = [
 	"nativescript",
 ];
 
-export class SaveOptions {
-	static PRODUCTION = "save";
-	static DEV = "save-dev";
-	static OPTIONAL = "save-optional";
-	static EXACT = "save-exact";
-}
-
 export class ReleaseType {
 	static MAJOR = "major";
 	static PREMAJOR = "premajor";

lib/contracts/package-manager.ts

@@ -1,7 +1,8 @@
 import { Contract } from "../common/di/contract";
 import type { IDictionary } from "../common/declarations";
 import type {
-	INodePackageManagerInstallOptions,
+	IPackageInstallOptions,
+	IPackageUninstallOptions,
 	INpmInstallResultInfo,
 	INpmPackageNameParts,
 	INpmsResult,
@@ -17,25 +18,25 @@ export abstract class PackageManager {
 	 * Installs dependency
 	 * @param  {string}                            packageName The name of the dependency - can be a path, a url or a string.
 	 * @param  {string}                            pathToSave  The destination of the installation.
-	 * @param  {INodePackageManagerInstallOptions} config      Additional options that can be passed to manipulate installation.
+	 * @param  {IPackageInstallOptions}            options     Package-manager-agnostic installation options.
 	 * @return {Promise<INpmInstallResultInfo>}                Information about installed package.
 	 */
 	abstract install(
 		packageName: string,
 		pathToSave: string,
-		config: INodePackageManagerInstallOptions,
+		options: IPackageInstallOptions,
 	): Promise<INpmInstallResultInfo>;
 
 	/**
 	 * Uninstalls a dependency
 	 * @param  {string}                            packageName The name of the dependency.
-	 * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate uninstallation.
+	 * @param  {IPackageUninstallOptions}          options     Package-manager-agnostic uninstallation options.
 	 * @param  {string}                            path  The destination of the uninstallation.
 	 * @return {Promise<string>}                The output of the uninstallation.
 	 */
 	abstract uninstall(
 		packageName: string,
-		config?: IDictionary<string | boolean>,
+		options?: IPackageUninstallOptions,
 		path?: string,
 	): Promise<string>;
 

lib/declarations.d.ts

@@ -27,25 +27,25 @@ interface INodePackageManager {
 	 * Installs dependency
 	 * @param  {string}                            packageName The name of the dependency - can be a path, a url or a string.
 	 * @param  {string}                            pathToSave  The destination of the installation.
-	 * @param  {INodePackageManagerInstallOptions} config      Additional options that can be passed to manipulate installation.
+	 * @param  {IPackageInstallOptions}            options     Package-manager-agnostic installation options.
 	 * @return {Promise<INpmInstallResultInfo>}                Information about installed package.
 	 */
 	install(
 		packageName: string,
 		pathToSave: string,
-		config: INodePackageManagerInstallOptions,
+		options: IPackageInstallOptions,
 	): Promise<INpmInstallResultInfo>;
 
 	/**
 	 * Uninstalls a dependency
 	 * @param  {string}                            packageName The name of the dependency.
-	 * @param  {IDictionary<string | boolean>} config      Additional options that can be passed to manipulate uninstallation.
+	 * @param  {IPackageUninstallOptions}          options     Package-manager-agnostic uninstallation options.
 	 * @param  {string}                            path  The destination of the uninstallation.
 	 * @return {Promise<string>}                The output of the uninstallation.
 	 */
 	uninstall(
 		packageName: string,
-		config?: IDictionary<string | boolean>,
+		options?: IPackageUninstallOptions,
 		path?: string,
 	): Promise<string>;
 
@@ -167,18 +167,42 @@ interface IPackageInstallationManager {
 }
 
 /**
- * Describes options that can be passed to manipulate package installation.
+ * Package-manager-agnostic installation options. Each package manager maps
+ * these onto its own command line flags; options a manager has no flag for
+ * are dropped rather than passed through.
  */
-interface INodePackageManagerInstallOptions
-	extends INpmInstallConfigurationOptions, IDictionary<string | boolean> {
-	/**
-	 * Destination of the installation.
-	 * @type {string}
-	 * @optional
-	 */
+interface IPackageInstallOptions {
+	/**
+	 * Record the package in package.json. Every supported package manager
+	 * does this by default, so only `false` changes behaviour.
+	 */
+	save?: boolean;
+	/** Record the package under devDependencies. */
+	dev?: boolean;
+	/** Record the package under optionalDependencies. */
+	optional?: boolean;
+	/** Pin the exact resolved version instead of a semver range. */
+	exact?: boolean;
+	/** Suppress the package manager's own output. */
+	silent?: boolean;
+	/** Do not run lifecycle scripts. */
+	ignoreScripts?: boolean;
+	/** Skip the installation entirely (the --disable-npm-install CLI flag). */
+	disableNpmInstall?: boolean;
+	/** Local runtime location (the --frameworkPath CLI flag). */
+	frameworkPath?: string;
+	/** Destination of the installation (the --path CLI flag). */
 	path?: string;
 }
 
+/**
+ * Package-manager-agnostic uninstallation options.
+ */
+interface IPackageUninstallOptions {
+	/** Remove the package from package.json. */
+	save?: boolean;
+}
+
 /**
  * Describes information about dependency packages.
  */
@@ -396,7 +420,8 @@ interface INpmInstallResultInfo {
 interface INpmInstallOptions {
 	pathToSave?: string;
 	version?: string;
-	dependencyType?: string;
+	/** Record the package under devDependencies. */
+	dev?: boolean;
 }
 
 /**

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

@@ -1,7 +1,8 @@
 import { isInteractive } from "../common/helpers";
 import {
 	INodePackageManager,
-	INodePackageManagerInstallOptions,
+	IPackageInstallOptions,
+	IPackageUninstallOptions,
 	INpmInstallResultInfo,
 	INpmsResult,
 	INpmPackageNameParts,
@@ -13,15 +14,33 @@ import {
 	IHostInfo,
 } from "../common/declarations";
 
+/**
+ * How one package manager spells each IPackageInstallOptions flag on its
+ * command line. A missing entry means the manager has no such flag and the
+ * option is dropped rather than passed through.
+ */
+export interface IPackageManagerFlags {
+	save?: string;
+	noSave?: string;
+	dev?: string;
+	optional?: string;
+	exact?: string;
+	silent?: string;
+	ignoreScripts?: string;
+}
+
 export abstract class BasePackageManager implements INodePackageManager {
+	protected abstract readonly installFlags: IPackageManagerFlags;
+	protected abstract readonly uninstallFlags: IPackageManagerFlags;
+
 	public abstract install(
 		packageName: string,
 		pathToSave: string,
-		config: INodePackageManagerInstallOptions,
+		options: IPackageInstallOptions,
 	): Promise<INpmInstallResultInfo>;
 	public abstract uninstall(
 		packageName: string,
-		config?: IDictionary<string | boolean>,
+		options?: IPackageUninstallOptions,
 		path?: string,
 	): Promise<string>;
 	public abstract view(packageName: string, config: Object): Promise<any>;
@@ -133,6 +152,37 @@ export abstract class BasePackageManager implements INodePackageManager {
 		};
 	}
 
+	protected getInstallFlags(options: IPackageInstallOptions): string[] {
+		return this.mapFlags(options, this.installFlags);
+	}
+
+	protected getUninstallFlags(options: IPackageUninstallOptions): string[] {
+		return this.mapFlags(options, this.uninstallFlags);
+	}
+
+	private mapFlags(
+		options: IPackageInstallOptions,
+		flags: IPackageManagerFlags,
+	): string[] {
+		const result: string[] = [];
+		if (!options) {
+			return result;
+		}
+		const push = (flag?: string) => {
+			if (flag) {
+				result.push(flag);
+			}
+		};
+		if (options.save === true) push(flags.save);
+		if (options.save === false) push(flags.noSave);
+		if (options.dev) push(flags.dev);
+		if (options.optional) push(flags.optional);
+		if (options.exact) push(flags.exact);
+		if (options.silent) push(flags.silent);
+		if (options.ignoreScripts) push(flags.ignoreScripts);
+		return result;
+	}
+
 	protected getFlagsString(config: any, asArray: boolean): any {
 		const array: Array<string> = [];
 		for (const flag in config) {

lib/package-managers/bun.ts

@@ -4,7 +4,8 @@ import { exported, cache } from "../common/decorators";
 import { CACACHE_DIRECTORY_NAME } from "../constants";
 import * as _ from "lodash";
 import {
-	INodePackageManagerInstallOptions,
+	IPackageInstallOptions,
+	IPackageUninstallOptions,
 	INpmInstallResultInfo,
 	INpmsResult,
 } from "../declarations";
@@ -17,7 +18,21 @@ import {
 } from "../common/declarations";
 import { injector } from "../common/yok";
 
-export class Bun extends BasePackageManager {
+export class BunPackageManager extends BasePackageManager {
+	protected readonly installFlags = {
+		save: "--save",
+		noSave: "--no-save",
+		dev: "--dev",
+		optional: "--optional",
+		exact: "--exact",
+		silent: "--silent",
+		ignoreScripts: "--ignore-scripts",
+	};
+	protected readonly uninstallFlags = {
+		save: "--save",
+		noSave: "--no-save",
+	};
+
 	constructor(
 		$childProcess: IChildProcess,
 		private $errors: IErrors,
@@ -34,19 +49,16 @@ export class Bun extends BasePackageManager {
 	public async install(
 		packageName: string,
 		pathToSave: string,
-		config: INodePackageManagerInstallOptions
+		options: IPackageInstallOptions
 	): Promise<INpmInstallResultInfo> {
-		if (config.disableNpmInstall) {
+		if (options.disableNpmInstall) {
 			return;
 		}
-		if (config.ignoreScripts) {
-			config["ignore-scripts"] = true;
-		}
 
 		const packageJsonPath = path.join(pathToSave, "package.json");
 		const jsonContentBefore = this.$fs.readJson(packageJsonPath);
 
-		const flags = this.getFlagsString(config, true);
+		const flags = this.getInstallFlags(options);
 		let params = ["install"];
 		const isInstallingAllDependencies = packageName === pathToSave;
 		if (!isInstallingAllDependencies) {
@@ -73,10 +85,10 @@ export class Bun extends BasePackageManager {
 	@exported("bun")
 	public async uninstall(
 		packageName: string,
-		config?: any,
+		options?: IPackageUninstallOptions,
 		cwd?: string
 	): Promise<string> {
-		const flags = this.getFlagsString(config, false);
+		const flags = this.getUninstallFlags(options).join(" ");
 		return this.$childProcess.exec(`bun remove ${packageName} ${flags}`, {
 			cwd,
 		});
@@ -152,4 +164,4 @@ export class Bun extends BasePackageManager {
 	}
 }
 
-injector.register("bun", Bun);
+injector.register("bun", BunPackageManager);