Skip to content

This PR add pnpm full support #5217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/bootstrap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ $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.requirePublic("pnpm", "./pnpm-package-manager");
$injector.requireCommand("package-manager|set", "./commands/package-manager-set");
$injector.requireCommand("package-manager|get", "./commands/package-manager-get");

Expand Down
2 changes: 2 additions & 0 deletions lib/common/commands/package-manager-set.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ export class PackageManagerCommand implements ICommand {
public execute(args: string[]): Promise<void> {
if (args[0] === 'yarn') {
return this.$userSettingsService.saveSetting("packageManager", "yarn");
} else if (args[0] === 'pnpm') {
return this.$userSettingsService.saveSetting("packageManager", "pnpm");
} else if (args[0] === 'npm') {
return this.$userSettingsService.saveSetting("packageManager", "npm");
}
Expand Down
1 change: 1 addition & 0 deletions lib/declarations.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,7 @@ interface IOptions extends IRelease, IDeviceIdentifier, IJustLaunch, IAvd, IAvai
frameworkName: string;
frameworkVersion: string;
yarn: string,
pnpm: string,
ipa: string;
tsc: boolean;
ts: boolean;
Expand Down
1 change: 1 addition & 0 deletions lib/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ export class Options {
ts: { type: OptionType.Boolean, hasSensitiveValue: false },
typescript: { type: OptionType.Boolean, hasSensitiveValue: false },
yarn: { type: OptionType.Boolean, hasSensitiveValue: false },
pnpm: { type: OptionType.Boolean, hasSensitiveValue: false },
androidTypings: { type: OptionType.Boolean, hasSensitiveValue: false },
bundle: { type: OptionType.String, hasSensitiveValue: false },
all: { type: OptionType.Boolean, hasSensitiveValue: false },
Expand Down
3 changes: 3 additions & 0 deletions lib/package-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export class PackageManager implements IPackageManager {
private $npm: INodePackageManager,
private $options: IOptions,
private $yarn: INodePackageManager,
private $pnpm: INodePackageManager,
private $logger: ILogger,
private $userSettingsService: IUserSettingsService
) { }
Expand Down Expand Up @@ -98,6 +99,8 @@ export class PackageManager implements IPackageManager {

if (pm === 'yarn' || this.$options.yarn) {
return this.$yarn;
} else if (pm === 'pnpm' || this.$options.pnpm) {
return this.$pnpm;
} else {
return this.$npm;
}
Expand Down
106 changes: 106 additions & 0 deletions lib/pnpm-package-manager.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
import * as path from "path";
import { BasePackageManager } from "./base-package-manager";
import { exported } from './common/decorators';
import { CACACHE_DIRECTORY_NAME } from "./constants";

export class PnpmPackageManager extends BasePackageManager {

constructor(
$childProcess: IChildProcess,
private $errors: IErrors,
$fs: IFileSystem,
$hostInfo: IHostInfo,
private $httpClient: Server.IHttpClient,
private $logger: ILogger,
$pacoteService: IPacoteService
) {
super($childProcess, $fs, $hostInfo, $pacoteService, 'pnpm');
}

@exported("pnpm")
public async install(packageName: string, pathToSave: string, config: INodePackageManagerInstallOptions): Promise<INpmInstallResultInfo> {
if (config.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);
// With pnpm we need to install as "flat" or some imports wont be found
let params = ['i', '--shamefully-hoist'];
const isInstallingAllDependencies = packageName === pathToSave;
if (!isInstallingAllDependencies) {
params.push(packageName);
}

params = params.concat(flags);
const cwd = pathToSave;

try {
const result = await this.processPackageManagerInstall(packageName, params, { cwd, isInstallingAllDependencies });
return result;
} catch (e) {
this.$fs.writeJson(packageJsonPath, jsonContentBefore);
throw e;
}
}

@exported("pnpm")
public uninstall(packageName: string, config?: IDictionary<string | boolean>, cwd?: string): Promise<string> {
// pnpm does not want save option in remove. It saves it by default
delete config['save'];
const flags = this.getFlagsString(config, false);
return this.$childProcess.exec(`pnpm remove ${packageName} ${flags}`, { cwd });
}

@exported("pnpm")
public async view(packageName: string, config: Object): Promise<any> {
const wrappedConfig = _.extend({}, config, { json: true });

const flags = this.getFlagsString(wrappedConfig, false);
let viewResult: any;
try {
viewResult = await this.$childProcess.exec(`pnpm info ${packageName} ${flags}`);
} catch (e) {
this.$errors.fail(e.message);
}
const result = JSON.parse(viewResult);
return result;
}

@exported("pnpm")
public search(filter: string[], config: IDictionary<string | boolean>): Promise<string> {
const flags = this.getFlagsString(config, false);
return this.$childProcess.exec(`pnpm search ${filter.join(" ")} ${flags}`);
}

public async searchNpms(keyword: string): Promise<INpmsResult> {
const httpRequestResult = await this.$httpClient.httpRequest(`https://api.npms.io/v2/search?q=keywords:${keyword}`);
const result: INpmsResult = JSON.parse(httpRequestResult.body);
return result;
}

@exported("pnpm")
public async getRegistryPackageData(packageName: string): Promise<any> {
const registry = await this.$childProcess.exec(`pnpm config get registry`);
const url = `${registry.trim()}/${packageName}`;
this.$logger.trace(`Trying to get data from pnpm registry for package ${packageName}, url is: ${url}`);
const responseData = (await this.$httpClient.httpRequest(url)).body;
this.$logger.trace(`Successfully received data from pnpm registry for package ${packageName}. Response data is: ${responseData}`);
const jsonData = JSON.parse(responseData);
this.$logger.trace(`Successfully parsed data from pnpm registry for package ${packageName}.`);
return jsonData;
}

@exported("pnpm")
public async getCachePath(): Promise<string> {
const cachePath = await this.$childProcess.exec(`pnpm config get cache`);
return path.join(cachePath.trim(), CACACHE_DIRECTORY_NAME);
}
}

$injector.register("pnpm", PnpmPackageManager);
2 changes: 2 additions & 0 deletions test/package-installation-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import * as HostInfoLib from "../lib/common/host-info";
import * as LoggerLib from "../lib/common/logger/logger";
import * as NpmLib from "../lib/node-package-manager";
import * as YarnLib from "../lib/yarn-package-manager";
import * as PnpmLib from "../lib/pnpm-package-manager";
import * as PackageManagerLib from "../lib/package-manager";
import * as PackageInstallationManagerLib from "../lib/package-installation-manager";
import * as OptionsLib from "../lib/options";
Expand Down Expand Up @@ -43,6 +44,7 @@ function createTestInjector(): IInjector {
});
testInjector.register("npm", NpmLib.NodePackageManager);
testInjector.register("yarn", YarnLib.YarnPackageManager);
testInjector.register("pnpm", PnpmLib.PnpmPackageManager);
testInjector.register("packageManager", PackageManagerLib.PackageManager);
testInjector.register("packageInstallationManager", PackageInstallationManagerLib.PackageInstallationManager);

Expand Down
2 changes: 2 additions & 0 deletions test/plugins-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { PackageManager } from "../lib/package-manager";
import { PackageInstallationManager } from "../lib/package-installation-manager";
import { NodePackageManager } from "../lib/node-package-manager";
import { YarnPackageManager } from "../lib/yarn-package-manager";
import { PnpmPackageManager } from "../lib/pnpm-package-manager";
import { FileSystem } from "../lib/common/file-system";
import { ProjectData } from "../lib/project-data";
import { ChildProcess } from "../lib/common/child-process";
Expand Down Expand Up @@ -50,6 +51,7 @@ function createTestInjector() {
testInjector.register("packageManager", PackageManager);
testInjector.register("npm", NodePackageManager);
testInjector.register("yarn", YarnPackageManager);
testInjector.register("pnpm", PnpmPackageManager);
testInjector.register("fs", FileSystem);
testInjector.register("adb", {});
testInjector.register("androidDebugBridgeResultHandler", {});
Expand Down
2 changes: 2 additions & 0 deletions test/services/extensibility-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { assert } from "chai";
import { NodePackageManager } from "../../lib/node-package-manager";
import { PackageManager } from "../../lib/package-manager";
import { YarnPackageManager } from "../../lib/yarn-package-manager";
import { PnpmPackageManager } from "../../lib/pnpm-package-manager";
import * as constants from "../../lib/constants";
import { ChildProcess } from "../../lib/common/child-process";
import { CommandsDelimiters } from "../../lib/common/constants";
Expand Down Expand Up @@ -58,6 +59,7 @@ describe("extensibilityService", () => {
});
testInjector.register("npm", NodePackageManager);
testInjector.register("yarn", YarnPackageManager);
testInjector.register("pnpm", PnpmPackageManager);
testInjector.register("settingsService", SettingsService);
testInjector.register("requireService", {
require: (pathToRequire: string): any => undefined
Expand Down