You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47 lines
2.6 KiB
47 lines
2.6 KiB
import { SpawnOptions, SpawnPromise, SpawnResult } from '@expo/spawn-async';
|
|
import { PendingSpawnPromise } from './utils/spawn';
|
|
export interface PackageManagerOptions extends SpawnOptions {
|
|
/**
|
|
* If the package manager should run in silent mode.
|
|
* Note, this will hide possible error output from executed commands.
|
|
* When running in silent mode, make sure you handle them properly.
|
|
*/
|
|
silent?: boolean;
|
|
/**
|
|
* The logging method used to communicate the command which is executed.
|
|
* Without `silent`, this defaults to `console.log`.
|
|
* When `silent` is set to `true`, this defaults to a no-op.
|
|
*/
|
|
log?: (...args: any[]) => void;
|
|
}
|
|
export interface PackageManager {
|
|
/** The options for this package manager */
|
|
readonly options: PackageManagerOptions;
|
|
/** Run any command using the package manager */
|
|
runAsync(command: string[]): SpawnPromise<SpawnResult>;
|
|
/** Get the version of the used package manager */
|
|
versionAsync(): Promise<string>;
|
|
/** Get a single configuration property from the package manager */
|
|
getConfigAsync(key: string): Promise<string>;
|
|
/** Remove the lock file within the project, if any */
|
|
removeLockfileAsync(): Promise<void>;
|
|
/** Get the workspace root package manager, if this project is within a workspace/monorepo */
|
|
workspaceRoot(): PackageManager | null;
|
|
/** Install all current dependencies using the package manager */
|
|
installAsync(): Promise<SpawnResult> | SpawnPromise<SpawnResult> | PendingSpawnPromise<SpawnResult>;
|
|
/** Uninstall all current dependencies by removing the folder containing the packages */
|
|
uninstallAsync(): Promise<void>;
|
|
/** Add a normal dependency to the project */
|
|
addAsync(namesOrFlags: string[]): SpawnPromise<SpawnResult> | PendingSpawnPromise<SpawnResult>;
|
|
/** Add a development dependency to the project */
|
|
addDevAsync(namesOrFlags: string[]): SpawnPromise<SpawnResult> | PendingSpawnPromise<SpawnResult>;
|
|
/** Add a global dependency to the environment */
|
|
addGlobalAsync(namesOrFlags: string[]): SpawnPromise<SpawnResult> | PendingSpawnPromise<SpawnResult>;
|
|
/** Remove a normal dependency from the project */
|
|
removeAsync(namesOrFlags: string[]): SpawnPromise<SpawnResult> | PendingSpawnPromise<SpawnResult>;
|
|
/** Remove a development dependency from the project */
|
|
removeDevAsync(namesOrFlags: string[]): SpawnPromise<SpawnResult> | PendingSpawnPromise<SpawnResult>;
|
|
/** Remove a global dependency from the environments */
|
|
removeGlobalAsync(namesOrFlags: string[]): SpawnPromise<SpawnResult> | PendingSpawnPromise<SpawnResult>;
|
|
}
|