-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
index.js
320 lines (263 loc) · 8.59 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
"use strict";
const { cosmiconfigSync } = require("cosmiconfig");
const dedent = require("dedent");
const globby = require("globby");
const globParent = require("glob-parent");
const loadJsonFile = require("load-json-file");
const log = require("npmlog");
const pMap = require("p-map");
const fs = require("fs");
const path = require("path");
const writeJsonFile = require("write-json-file");
const { load } = require("js-yaml");
const { ValidationError } = require("@lerna/validation-error");
const { Package } = require("@lerna/package");
const { applyExtends } = require("./lib/apply-extends");
const { deprecateConfig } = require("./lib/deprecate-config");
const { makeFileFinder, makeSyncFileFinder } = require("./lib/make-file-finder");
/**
* @typedef {object} ProjectConfig
* @property {string[]} packages
* @property {boolean} useNx
* @property {boolean} useWorkspaces
* @property {string} version
* @property {string} npmClient
*/
/**
* @typedef {object} PnpmWorkspaceConfig
* @property {string[]} packages
*/
/**
* A representation of the entire project managed by Lerna.
*
* Wherever the lerna.json file is located, that is the project root.
* All package globs are rooted from this location.
*/
class Project {
/**
* @param {string} [cwd] Defaults to process.cwd()
*/
static getPackages(cwd) {
return new Project(cwd).getPackages();
}
/**
* @param {string} [cwd] Defaults to process.cwd()
*/
static getPackagesSync(cwd) {
return new Project(cwd).getPackagesSync();
}
/**
* @param {string} [cwd] Defaults to process.cwd()
*/
constructor(cwd) {
const explorer = cosmiconfigSync("lerna", {
searchPlaces: ["lerna.json", "package.json"],
transform(obj) {
// cosmiconfig returns null when nothing is found
if (!obj) {
return {
// No need to distinguish between missing and empty,
// saves a lot of noisy guards elsewhere
config: {},
configNotFound: true,
// path.resolve(".", ...) starts from process.cwd()
filepath: path.resolve(cwd || ".", "lerna.json"),
};
}
// rename deprecated durable config
deprecateConfig(obj.config, obj.filepath);
obj.config = applyExtends(obj.config, path.dirname(obj.filepath));
return obj;
},
});
let loaded;
try {
loaded = explorer.search(cwd);
} catch (err) {
// redecorate JSON syntax errors, avoid debug dump
if (err.name === "JSONError") {
throw new ValidationError(err.name, err.message);
}
// re-throw other errors, could be ours or third-party
throw err;
}
/** @type {ProjectConfig} */
this.config = loaded.config;
this.configNotFound = loaded.configNotFound;
this.rootConfigLocation = loaded.filepath;
this.rootPath = path.dirname(loaded.filepath);
log.verbose("rootPath", this.rootPath);
}
get version() {
return this.config.version;
}
set version(val) {
this.config.version = val;
}
get packageConfigs() {
if (this.config.npmClient === "pnpm") {
log.verbose(
"packageConfigs",
"Package manager 'pnpm' detected. Resolving packages using 'pnpm-workspace.yaml'."
);
const workspaces = this.pnpmWorkspaceConfig.packages;
if (!workspaces) {
throw new ValidationError(
"EWORKSPACES",
"No 'packages' property found in pnpm-workspace.yaml. See https://pnpm.io/workspaces for help configuring workspaces in pnpm."
);
}
return workspaces;
}
if (this.config.useWorkspaces) {
const workspaces = this.manifest.get("workspaces");
if (!workspaces) {
throw new ValidationError(
"EWORKSPACES",
dedent`
Workspaces need to be defined in the root package.json.
See: https://github.com/lerna/lerna/blob/master/commands/bootstrap/README.md#--use-workspaces
`
);
}
return workspaces.packages || workspaces;
}
if (this.manifest.get("workspaces")) {
log.warn(
"EWORKSPACES",
dedent`
Workspaces exist in the root package.json, but Lerna is not configured to use them.
To fix this and have Lerna use workspaces to resolve packages, set \`useWorkspaces: true\` in lerna.json.
`
);
}
if (this.config.packages) {
return this.config.packages;
}
log.warn(
"EPACKAGES",
`No packages defined in lerna.json. Defaulting to packages in ${Project.PACKAGE_GLOB}`
);
return [Project.PACKAGE_GLOB];
}
get packageParentDirs() {
return this.packageConfigs.map(globParent).map((parentDir) => path.resolve(this.rootPath, parentDir));
}
get manifest() {
let manifest;
try {
const manifestLocation = path.join(this.rootPath, "package.json");
const packageJson = loadJsonFile.sync(manifestLocation);
if (!packageJson.name) {
// npm-lifecycle chokes if this is missing, so default like npm init does
packageJson.name = path.basename(path.dirname(manifestLocation));
}
// Encapsulate raw JSON in Package instance
manifest = new Package(packageJson, this.rootPath);
// redefine getter to lazy-loaded value
Object.defineProperty(this, "manifest", {
value: manifest,
});
} catch (err) {
// redecorate JSON syntax errors, avoid debug dump
if (err.name === "JSONError") {
throw new ValidationError(err.name, err.message);
}
// try again next time
}
return manifest;
}
/** @type {PnpmWorkspaceConfig} */
get pnpmWorkspaceConfig() {
let config;
try {
const configLocation = path.join(this.rootPath, "pnpm-workspace.yaml");
const configContent = fs.readFileSync(configLocation);
config = load(configContent);
Object.defineProperty(this, "pnpmWorkspaceConfig", {
value: config,
});
} catch (err) {
if (err.message.includes("ENOENT: no such file or directory")) {
throw new ValidationError(
"ENOENT",
"No pnpm-workspace.yaml found. See https://pnpm.io/workspaces for help configuring workspaces in pnpm."
);
}
throw new ValidationError(err.name, err.message);
}
return config;
}
get licensePath() {
let licensePath;
try {
const search = globby.sync(Project.LICENSE_GLOB, {
cwd: this.rootPath,
absolute: true,
caseSensitiveMatch: false,
// Project license is always a sibling of the root manifest
deep: 0,
});
licensePath = search.shift();
if (licensePath) {
// POSIX results always need to be normalized
licensePath = path.normalize(licensePath);
// redefine getter to lazy-loaded value
Object.defineProperty(this, "licensePath", {
value: licensePath,
});
}
} catch (err) {
/* istanbul ignore next */
throw new ValidationError(err.name, err.message);
}
return licensePath;
}
get fileFinder() {
const finder = makeFileFinder(this.rootPath, this.packageConfigs);
// redefine getter to lazy-loaded value
Object.defineProperty(this, "fileFinder", {
value: finder,
});
return finder;
}
/**
* @returns {Promise<Package[]>} A promise resolving to a list of Package instances
*/
getPackages() {
const mapper = (packageConfigPath) =>
loadJsonFile(packageConfigPath).then(
(packageJson) => new Package(packageJson, path.dirname(packageConfigPath), this.rootPath)
);
return this.fileFinder("package.json", (filePaths) => pMap(filePaths, mapper, { concurrency: 50 }));
}
/**
* @returns {Package[]} A list of Package instances
*/
getPackagesSync() {
return makeSyncFileFinder(this.rootPath, this.packageConfigs)("package.json", (packageConfigPath) => {
return new Package(
loadJsonFile.sync(packageConfigPath),
path.dirname(packageConfigPath),
this.rootPath
);
});
}
getPackageLicensePaths() {
return this.fileFinder(Project.LICENSE_GLOB, null, { caseSensitiveMatch: false });
}
isIndependent() {
return this.version === "independent";
}
serializeConfig() {
// TODO: might be package.json prop
return writeJsonFile(this.rootConfigLocation, this.config, { indent: 2, detectIndent: true }).then(
() => this.rootConfigLocation
);
}
}
Project.PACKAGE_GLOB = "packages/*";
Project.LICENSE_GLOB = "LICEN{S,C}E{,.*}";
module.exports.Project = Project;
module.exports.getPackages = Project.getPackages;
module.exports.getPackagesSync = Project.getPackagesSync;