Visitar URL original
refactor: manager-agnostic view/search and resolution-based package l… · NativeScript/nativescript-cli@f3f4e1b · GitHub
Skip to content

Commit f3f4e1b

Browse files
rigor789rigor789
committed
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.
1 parent 1157cae commit f3f4e1b

20 files changed

Lines changed: 158 additions & 237 deletions

‎PublicAPI.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -556,16 +556,15 @@ Searches for a package using keywords.
556556
```TypeScript
557557
/**
558558
* Searches for a package.
559-
* @param {string[]} filter Keywords with which to perform the search.
560-
* @param {IDictionary<string | boolean>} config Additional options that can be passed to manipulate search.
561-
* @return {Promise<string>} The output of the uninstallation.
559+
* @param {string[]} filter Keywords with which to perform the search.
560+
* @return {Promise<string>} The raw search output.
562561
*/
563-
search(filter: string[], config: IDictionary<string | boolean>): Promise<string>;
562+
search(filter: string[]): Promise<string>;
564563
```
565564
566565
* Usage:
567566
```JavaScript
568-
tns.npm.search(["nativescript", "cloud"], { silent: true }).then(output => {
567+
tns.npm.search(["nativescript", "cloud"]).then(output => {
569568
console.log(`Found: ${output}`);
570569
}, err => {
571570
console.log("An error occurred during searching", err);
@@ -578,17 +577,17 @@ Provides information about a given package.
578577
* Definition
579578
```TypeScript
580579
/**
581-
* Provides information about a given package.
582-
* @param {string} packageName The name of the package.
583-
* @param {IDictionary<string | boolean>} config Additional options that can be passed to manipulate view.
584-
* @return {Promise<any>} Object, containing information about the package.
580+
* Provides registry information about a package.
581+
* @param {string} packageName The name of the package, optionally with a version.
582+
* @param {string} field Optional single registry field (e.g. "versions" or "dist-tags") to return instead of the whole document.
583+
* @return {Promise<any>} The parsed registry data.
585584
*/
586-
view(packageName: string, config: Object): Promise<any>;
585+
view(packageName: string, field?: string): Promise<any>;
587586
```
588587
589588
* Usage:
590589
```JavaScript
591-
tns.npm.view(["nativescript"], {}).then(result => {
590+
tns.npm.view("nativescript").then(result => {
592591
console.log(`${result.name}'s latest version is ${result["dist-tags"].latest}`);
593592
}, err => {
594593
console.log("An error occurred during viewing", err);

‎lib/commands/test-init.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import * as path from "path";
22
import * as _ from "lodash";
33
import { TESTING_FRAMEWORKS, ProjectTypes } from "../constants";
44
import { fromWindowsRelativePathToUnix } from "../common/helpers";
5+
import { resolvePackageJSONPath } from "../helpers/package-path-helper";
56
import {
67
IProjectData,
78
ITestInitializationService,
@@ -137,9 +138,9 @@ export class TestInitCommand extends Command({
137138
path: this.$options.path,
138139
});
139140

140-
const modulePath = path.join(projectDir, "node_modules", mod.name);
141-
const modulePackageJsonPath = path.join(modulePath, "package.json");
142-
const modulePackageJsonContent = this.$fs.readJson(modulePackageJsonPath);
141+
const modulePackageJsonContent = this.$fs.readJson(
142+
resolvePackageJSONPath(mod.name, { paths: [projectDir] }),
143+
);
143144
const modulePeerDependencies =
144145
modulePackageJsonContent.peerDependencies || {};
145146
const modulePeerDependenciesMeta =

‎lib/contracts/package-manager.ts‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import { Contract } from "../common/di/contract";
2-
import type { IDictionary } from "../common/declarations";
32
import type {
43
IPackageInstallOptions,
54
IPackageUninstallOptions,
@@ -42,11 +41,11 @@ export abstract class PackageManager {
4241

4342
/**
4443
* Provides information about a given package.
45-
* @param {string} packageName The name of the package.
46-
* @param {IDictionary<string | boolean>} config Additional options that can be passed to manipulate view.
47-
* @return {Promise<any>} Object, containing information about the package.
44+
* @param {string} packageName The name of the package, optionally with a version.
45+
* @param {string} field @optional A single registry field (e.g. "versions" or "dist-tags") to return instead of the whole document.
46+
* @return {Promise<any>} The parsed registry data, or null when it cannot be parsed.
4847
*/
49-
abstract view(packageName: string, config: Object): Promise<any>;
48+
abstract view(packageName: string, field?: string): Promise<any>;
5049

5150
/**
5251
* Checks if the specified string is name of a packaged published in the NPM registry.
@@ -75,14 +74,10 @@ export abstract class PackageManager {
7574

7675
/**
7776
* Searches for a package.
78-
* @param {string[]} filter Keywords with which to perform the search.
79-
* @param {IDictionary<string | boolean>} config Additional options that can be passed to manipulate search.
80-
* @return {Promise<string>} The output of the uninstallation.
77+
* @param {string[]} filter Keywords with which to perform the search.
78+
* @return {Promise<string>} The raw search output.
8179
*/
82-
abstract search(
83-
filter: string[],
84-
config: IDictionary<string | boolean>,
85-
): Promise<string>;
80+
abstract search(filter: string[]): Promise<string>;
8681

8782
/**
8883
* Searches for npm packages in npms by keyword.

‎lib/declarations.d.ts‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,13 @@ interface INodePackageManager {
5555
* @param {IDictionary<string | boolean>} config Additional options that can be passed to manipulate view.
5656
* @return {Promise<any>} Object, containing information about the package.
5757
*/
58-
view(packageName: string, config: Object): Promise<any>;
58+
/**
59+
* Provides registry information about a package.
60+
* @param {string} packageName The name of the package, optionally with a version.
61+
* @param {string} field @optional A single registry field (e.g. "versions" or "dist-tags") to return instead of the whole document.
62+
* @return {Promise<any>} The parsed registry data, or null when it cannot be parsed.
63+
*/
64+
view(packageName: string, field?: string): Promise<any>;
5965

6066
/**
6167
* Checks if the specified string is name of a packaged published in the NPM registry.
@@ -84,10 +90,7 @@ interface INodePackageManager {
8490
* @param {IDictionary<string | boolean>} config Additional options that can be passed to manipulate search.
8591
* @return {Promise<string>} The output of the uninstallation.
8692
*/
87-
search(
88-
filter: string[],
89-
config: IDictionary<string | boolean>,
90-
): Promise<string>;
93+
search(filter: string[]): Promise<string>;
9194

9295
/**
9396
* Searches for npm packages in npms by keyword.

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

Lines changed: 4 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,7 @@ import {
77
INpmsResult,
88
INpmPackageNameParts,
99
} from "../declarations";
10-
import {
11-
IDictionary,
12-
IChildProcess,
13-
IFileSystem,
14-
IHostInfo,
15-
} from "../common/declarations";
10+
import { IChildProcess, IFileSystem, IHostInfo } from "../common/declarations";
1611

1712
/**
1813
* How one package manager spells each IPackageInstallOptions flag on its
@@ -43,11 +38,8 @@ export abstract class BasePackageManager implements INodePackageManager {
4338
options?: IPackageUninstallOptions,
4439
path?: string,
4540
): Promise<string>;
46-
public abstract view(packageName: string, config: Object): Promise<any>;
47-
public abstract search(
48-
filter: string[],
49-
config: IDictionary<string | boolean>,
50-
): Promise<string>;
41+
public abstract view(packageName: string, field?: string): Promise<any>;
42+
public abstract search(filter: string[]): Promise<string>;
5143
public abstract searchNpms(keyword: string): Promise<INpmsResult>;
5244
public abstract getRegistryPackageData(packageName: string): Promise<any>;
5345
public abstract getCachePath(): Promise<string>;
@@ -70,7 +62,7 @@ export abstract class BasePackageManager implements INodePackageManager {
7062
}
7163

7264
try {
73-
const viewResult = await this.view(packageName, { name: true });
65+
const viewResult = await this.view(packageName, "name");
7466

7567
// `npm view nonExistingPackageName` will return `nativescript`
7668
// if executed in the root dir of the CLI (npm 6.4.1)
@@ -183,41 +175,6 @@ export abstract class BasePackageManager implements INodePackageManager {
183175
return result;
184176
}
185177

186-
protected getFlagsString(config: any, asArray: boolean): any {
187-
const array: Array<string> = [];
188-
for (const flag in config) {
189-
if (
190-
flag === "global" &&
191-
this.packageManager !== "yarn" &&
192-
this.packageManager !== "yarn2"
193-
) {
194-
array.push(`--${flag}`);
195-
array.push(`${config[flag]}`);
196-
} else if (config[flag]) {
197-
if (
198-
flag === "dist-tags" ||
199-
flag === "versions" ||
200-
flag === "name" ||
201-
flag === "gradle" ||
202-
flag === "version_info"
203-
) {
204-
if (this.packageManager === "yarn2") {
205-
array.push(`--fields ${flag}`);
206-
} else {
207-
array.push(` ${flag}`);
208-
}
209-
continue;
210-
}
211-
array.push(`--${flag}`);
212-
}
213-
}
214-
if (asArray) {
215-
return array;
216-
}
217-
218-
return array.join(" ");
219-
}
220-
221178
private isTgz(packageName: string): boolean {
222179
return packageName.indexOf(".tgz") >= 0;
223180
}

‎lib/package-managers/bun.ts‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -94,17 +94,13 @@ export class BunPackageManager extends BasePackageManager {
9494
});
9595
}
9696

97-
// Bun does not have a `view` command; use npm.
9897
@exported("bun")
99-
public async view(packageName: string, config: Object): Promise<any> {
100-
const wrappedConfig = _.extend({}, config, { json: true }); // always require view response as JSON
101-
102-
const flags = this.getFlagsString(wrappedConfig, false);
98+
// Bun does not have a `view` command; use npm.
99+
public async view(packageName: string, field?: string): Promise<any> {
100+
const args = [packageName, field, "--json"].filter(Boolean).join(" ");
103101
let viewResult: any;
104102
try {
105-
viewResult = await this.$childProcess.exec(
106-
`npm view ${packageName} ${flags}`
107-
);
103+
viewResult = await this.$childProcess.exec(`npm view ${args}`);
108104
} catch (e) {
109105
this.$errors.fail(e.message);
110106
}
@@ -116,11 +112,10 @@ export class BunPackageManager extends BasePackageManager {
116112
}
117113
}
118114

119-
// Bun does not have a `search` command; use npm.
120115
@exported("bun")
121-
public async search(filter: string[], config: any): Promise<string> {
122-
const flags = this.getFlagsString(config, false);
123-
return this.$childProcess.exec(`npm search ${filter.join(" ")} ${flags}`);
116+
// Bun does not have a `search` command; use npm.
117+
public async search(filter: string[]): Promise<string> {
118+
return this.$childProcess.exec(`npm search ${filter.join(" ")}`);
124119
}
125120

126121
public async searchNpms(keyword: string): Promise<INpmsResult> {

‎lib/package-managers/index.ts‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ import {
1414
import {
1515
IErrors,
1616
IUserSettingsService,
17-
IDictionary,
1817
} from "../common/declarations";
1918
import { injector } from "../common/yok";
2019
import { IProjectConfigService } from "../definitions/project";
@@ -66,16 +65,13 @@ export class PackageManager implements IPackageManager {
6665
}
6766
@exported("packageManager")
6867
@invokeInit()
69-
public view(packageName: string, config: Object): Promise<any> {
70-
return this.packageManager.view(packageName, config);
68+
public view(packageName: string, field?: string): Promise<any> {
69+
return this.packageManager.view(packageName, field);
7170
}
7271
@exported("packageManager")
7372
@invokeInit()
74-
public search(
75-
filter: string[],
76-
config: IDictionary<string | boolean>
77-
): Promise<string> {
78-
return this.packageManager.search(filter, config);
73+
public search(filter: string[]): Promise<string> {
74+
return this.packageManager.search(filter);
7975
}
8076

8177
@invokeInit()
@@ -122,7 +118,7 @@ export class PackageManager implements IPackageManager {
122118
}
123119

124120
try {
125-
const result = await this.view(packageName, { "dist-tags": true });
121+
const result = await this.view(packageName, "dist-tags");
126122
version = result[tag];
127123
} catch (err) {
128124
this.$logger.trace(

‎lib/package-managers/npm.ts‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -125,21 +125,16 @@ export class NpmPackageManager extends BasePackageManager {
125125
}
126126

127127
@exported("npm")
128-
public async search(filter: string[], config: any): Promise<string> {
129-
const flags = this.getFlagsString(config, false);
130-
return this.$childProcess.exec(`npm search ${filter.join(" ")} ${flags}`);
128+
public async search(filter: string[]): Promise<string> {
129+
return this.$childProcess.exec(`npm search ${filter.join(" ")}`);
131130
}
132131

133132
@exported("npm")
134-
public async view(packageName: string, config: Object): Promise<any> {
135-
const wrappedConfig = _.extend({}, config, { json: true }); // always require view response as JSON
136-
137-
const flags = this.getFlagsString(wrappedConfig, false);
133+
public async view(packageName: string, field?: string): Promise<any> {
134+
const args = [packageName, field, "--json"].filter(Boolean).join(" ");
138135
let viewResult: any;
139136
try {
140-
viewResult = await this.$childProcess.exec(
141-
`npm view ${packageName} ${flags}`
142-
);
137+
viewResult = await this.$childProcess.exec(`npm view ${args}`);
143138
} catch (e) {
144139
this.$errors.fail(e.message);
145140
}

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

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import * as path from "path";
22
import * as constants from "../constants";
3+
import { resolvePackagePath } from "../helpers/package-path-helper";
34
import {
45
INpmInstallOptions,
56
INpmInstallResultInfo,
@@ -67,9 +68,7 @@ export class PackageInstallationManager implements IPackageInstallationManager {
6768
packageName: string,
6869
versionRange: string
6970
): Promise<string> {
70-
const data = await this.$packageManager.view(packageName, {
71-
versions: true,
72-
});
71+
const data = await this.$packageManager.view(packageName, "versions");
7372

7473
let versions;
7574

@@ -190,14 +189,11 @@ export class PackageInstallationManager implements IPackageInstallationManager {
190189
inspectorNpmPackageName: string,
191190
projectDir: string
192191
): Promise<string> {
193-
const inspectorPath = path.join(
194-
projectDir,
195-
constants.NODE_MODULES_FOLDER_NAME,
196-
inspectorNpmPackageName
197-
);
198-
199192
// local installation takes precedence over cache
200-
if (this.inspectorAlreadyInstalled(inspectorPath)) {
193+
const inspectorPath = resolvePackagePath(inspectorNpmPackageName, {
194+
paths: [projectDir],
195+
});
196+
if (inspectorPath) {
201197
return inspectorPath;
202198
}
203199

@@ -266,14 +262,6 @@ export class PackageInstallationManager implements IPackageInstallationManager {
266262
}
267263
}
268264

269-
private inspectorAlreadyInstalled(pathToInspector: string): Boolean {
270-
if (this.$fs.exists(pathToInspector)) {
271-
return true;
272-
}
273-
274-
return false;
275-
}
276-
277265
private async installCore(
278266
packageName: string,
279267
pathToSave: string,
@@ -293,15 +281,7 @@ export class PackageInstallationManager implements IPackageInstallationManager {
293281
version,
294282
dev
295283
);
296-
const installedPackageName = installResultInfo.name;
297-
298-
const pathToInstalledPackage = path.join(
299-
pathToSave,
300-
"node_modules",
301-
installedPackageName
302-
);
303-
304-
return pathToInstalledPackage;
284+
return resolvePackagePath(installResultInfo.name, { paths: [pathToSave] });
305285
}
306286

307287
private async npmInstall(
@@ -335,9 +315,7 @@ export class PackageInstallationManager implements IPackageInstallationManager {
335315
packageName: string,
336316
version: string
337317
): Promise<string> {
338-
let data: any = await this.$packageManager.view(packageName, {
339-
"dist-tags": true,
340-
});
318+
let data: any = await this.$packageManager.view(packageName, "dist-tags");
341319
data = data?.["dist-tags"] ?? data;
342320
this.$logger.trace("Using version %s. ", data[version]);
343321

0 commit comments

Comments
 (0)