This repository was archived by the owner on Apr 4, 2025. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathindex.ts
More file actions
836 lines (719 loc) · 26.6 KB
/
Copy pathindex.ts
File metadata and controls
836 lines (719 loc) · 26.6 KB
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
/**
* @license
* Copyright Google Inc. All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import { logging } from '@angular-devkit/core';
import {
Rule,
SchematicContext,
SchematicsException,
TaskId,
Tree,
} from '@angular-devkit/schematics';
import { NodePackageInstallTask, RunSchematicTask } from '@angular-devkit/schematics/tasks';
import { Observable, from as observableFrom, of } from 'rxjs';
import { map, mergeMap, reduce, switchMap } from 'rxjs/operators';
import * as semver from 'semver';
import { getNpmPackageJson } from './npm';
import { NpmRepositoryPackageJson } from './npm-package-json';
import { Dependency, JsonSchemaForNpmPackageJsonFiles } from './package-json';
import { UpdateSchema } from './schema';
type VersionRange = string & { __VERSION_RANGE: void; };
type PeerVersionTransform = string | ((range: string) => string);
// This is a map of packageGroupName to range extending function. If it isn't found, the range is
// kept the same.
// Angular guarantees that a major is compatible with its following major (so packages that depend
// on Angular 5 are also compatible with Angular 6). This is, in code, represented by verifying
// that all other packages that have a peer dependency of `"@angular/core": "^5.0.0"` actually
// supports 6.0, by adding that compatibility to the range, so it is `^5.0.0 || ^6.0.0`.
const peerCompatibleWhitelist: { [name: string]: PeerVersionTransform } = {
'@angular/core': (range: string) => {
range = semver.validRange(range);
let major = 1;
while (!semver.gtr(major + '.0.0', range)) {
major++;
if (major >= 99) {
throw new SchematicsException(`Invalid range: ${JSON.stringify(range)}`);
}
}
// Add the major version as compatible with the angular compatible. This is already one
// major above the greatest supported, because we increment `major` before checking.
return semver.validRange(`^${major}.0.0-rc.0 || ${range}`) || range;
},
};
interface PackageVersionInfo {
version: VersionRange;
packageJson: JsonSchemaForNpmPackageJsonFiles;
updateMetadata: UpdateMetadata;
}
interface PackageInfo {
name: string;
npmPackageJson: NpmRepositoryPackageJson;
installed: PackageVersionInfo;
target?: PackageVersionInfo;
packageJsonRange: string;
}
interface UpdateMetadata {
packageGroup: string[];
requirements: { [packageName: string]: string };
migrations?: string;
}
function _updatePeerVersion(infoMap: Map<string, PackageInfo>, name: string, range: string) {
// Resolve packageGroupName.
const maybePackageInfo = infoMap.get(name);
if (!maybePackageInfo) {
return range;
}
if (maybePackageInfo.target) {
name = maybePackageInfo.target.updateMetadata.packageGroup[0] || name;
} else {
name = maybePackageInfo.installed.updateMetadata.packageGroup[0] || name;
}
const maybeTransform = peerCompatibleWhitelist[name];
if (maybeTransform) {
if (typeof maybeTransform == 'function') {
return maybeTransform(range);
} else {
return maybeTransform;
}
}
return range;
}
function _validateForwardPeerDependencies(
name: string,
infoMap: Map<string, PackageInfo>,
peers: {[name: string]: string},
logger: logging.LoggerApi,
): boolean {
for (const [peer, range] of Object.entries(peers)) {
logger.debug(`Checking forward peer ${peer}...`);
const maybePeerInfo = infoMap.get(peer);
if (!maybePeerInfo) {
logger.error([
`Package ${JSON.stringify(name)} has a missing peer dependency of`,
`${JSON.stringify(peer)} @ ${JSON.stringify(range)}.`,
].join(' '));
return true;
}
const peerVersion = maybePeerInfo.target && maybePeerInfo.target.packageJson.version
? maybePeerInfo.target.packageJson.version
: maybePeerInfo.installed.version;
logger.debug(` Range intersects(${range}, ${peerVersion})...`);
if (!semver.satisfies(peerVersion, range)) {
logger.error([
`Package ${JSON.stringify(name)} has an incompatible peer dependency to`,
`${JSON.stringify(peer)} (requires ${JSON.stringify(range)},`,
`would install ${JSON.stringify(peerVersion)})`,
].join(' '));
return true;
}
}
return false;
}
function _validateReversePeerDependencies(
name: string,
version: string,
infoMap: Map<string, PackageInfo>,
logger: logging.LoggerApi,
) {
for (const [installed, installedInfo] of infoMap.entries()) {
const installedLogger = logger.createChild(installed);
installedLogger.debug(`${installed}...`);
const peers = (installedInfo.target || installedInfo.installed).packageJson.peerDependencies;
for (let [peer, range] of Object.entries(peers || {})) {
if (peer != name) {
// Only check peers to the packages we're updating. We don't care about peers
// that are unmet but we have no effect on.
continue;
}
// Override the peer version range if it's whitelisted.
range = _updatePeerVersion(infoMap, peer, range);
if (!semver.satisfies(version, range)) {
logger.error([
`Package ${JSON.stringify(installed)} has an incompatible peer dependency to`,
`${JSON.stringify(name)} (requires ${JSON.stringify(range)},`,
`would install ${JSON.stringify(version)}).`,
].join(' '));
return true;
}
}
}
return false;
}
function _validateUpdatePackages(
infoMap: Map<string, PackageInfo>,
force: boolean,
logger: logging.LoggerApi,
): void {
logger.debug('Updating the following packages:');
infoMap.forEach(info => {
if (info.target) {
logger.debug(` ${info.name} => ${info.target.version}`);
}
});
let peerErrors = false;
infoMap.forEach(info => {
const {name, target} = info;
if (!target) {
return;
}
const pkgLogger = logger.createChild(name);
logger.debug(`${name}...`);
const peers = target.packageJson.peerDependencies || {};
peerErrors = _validateForwardPeerDependencies(name, infoMap, peers, pkgLogger) || peerErrors;
peerErrors
= _validateReversePeerDependencies(name, target.version, infoMap, pkgLogger)
|| peerErrors;
});
if (!force && peerErrors) {
throw new SchematicsException(`Incompatible peer dependencies found. See above.`);
}
}
function _performUpdate(
tree: Tree,
context: SchematicContext,
infoMap: Map<string, PackageInfo>,
logger: logging.LoggerApi,
migrateOnly: boolean,
): Observable<void> {
const packageJsonContent = tree.read('/package.json');
if (!packageJsonContent) {
throw new SchematicsException('Could not find a package.json. Are you in a Node project?');
}
let packageJson: JsonSchemaForNpmPackageJsonFiles;
try {
packageJson = JSON.parse(packageJsonContent.toString()) as JsonSchemaForNpmPackageJsonFiles;
} catch (e) {
throw new SchematicsException('package.json could not be parsed: ' + e.message);
}
const updateDependency = (deps: Dependency, name: string, newVersion: string) => {
const oldVersion = deps[name];
// We only respect caret and tilde ranges on update.
const execResult = /^[\^~]/.exec(oldVersion);
deps[name] = `${execResult ? execResult[0] : ''}${newVersion}`;
};
const toInstall = [...infoMap.values()]
.map(x => [x.name, x.target, x.installed])
// tslint:disable-next-line:non-null-operator
.filter(([name, target, installed]) => {
return !!name && !!target && !!installed;
}) as [string, PackageVersionInfo, PackageVersionInfo][];
toInstall.forEach(([name, target, installed]) => {
logger.info(
`Updating package.json with dependency ${name} `
+ `@ ${JSON.stringify(target.version)} (was ${JSON.stringify(installed.version)})...`,
);
if (packageJson.dependencies && packageJson.dependencies[name]) {
updateDependency(packageJson.dependencies, name, target.version);
if (packageJson.devDependencies && packageJson.devDependencies[name]) {
delete packageJson.devDependencies[name];
}
if (packageJson.peerDependencies && packageJson.peerDependencies[name]) {
delete packageJson.peerDependencies[name];
}
} else if (packageJson.devDependencies && packageJson.devDependencies[name]) {
updateDependency(packageJson.devDependencies, name, target.version);
if (packageJson.peerDependencies && packageJson.peerDependencies[name]) {
delete packageJson.peerDependencies[name];
}
} else if (packageJson.peerDependencies && packageJson.peerDependencies[name]) {
updateDependency(packageJson.peerDependencies, name, target.version);
} else {
logger.warn(`Package ${name} was not found in dependencies.`);
}
});
const newContent = JSON.stringify(packageJson, null, 2);
if (packageJsonContent.toString() != newContent || migrateOnly) {
let installTask: TaskId[] = [];
if (!migrateOnly) {
// If something changed, also hook up the task.
tree.overwrite('/package.json', JSON.stringify(packageJson, null, 2));
installTask = [context.addTask(new NodePackageInstallTask())];
}
// Run the migrate schematics with the list of packages to use. The collection contains
// version information and we need to do this post installation. Please note that the
// migration COULD fail and leave side effects on disk.
// Run the schematics task of those packages.
toInstall.forEach(([name, target, installed]) => {
if (!target.updateMetadata.migrations) {
return;
}
const collection = (
target.updateMetadata.migrations.match(/^[./]/)
? name + '/'
: ''
) + target.updateMetadata.migrations;
context.addTask(new RunSchematicTask('@schematics/update', 'migrate', {
package: name,
collection,
from: installed.version,
to: target.version,
}),
installTask,
);
});
}
return of<void>(undefined);
}
function _migrateOnly(
info: PackageInfo | undefined,
context: SchematicContext,
from: string,
to?: string,
) {
if (!info) {
return of<void>();
}
const target = info.installed;
if (!target || !target.updateMetadata.migrations) {
return of<void>(undefined);
}
const collection = (
target.updateMetadata.migrations.match(/^[./]/)
? info.name + '/'
: ''
) + target.updateMetadata.migrations;
context.addTask(new RunSchematicTask('@schematics/update', 'migrate', {
package: info.name,
collection,
from: from,
to: to || target.version,
}),
);
return of<void>(undefined);
}
function _getUpdateMetadata(
packageJson: JsonSchemaForNpmPackageJsonFiles,
logger: logging.LoggerApi,
): UpdateMetadata {
const metadata = packageJson['ng-update'];
const result: UpdateMetadata = {
packageGroup: [],
requirements: {},
};
if (!metadata || typeof metadata != 'object' || Array.isArray(metadata)) {
return result;
}
if (metadata['packageGroup']) {
const packageGroup = metadata['packageGroup'];
// Verify that packageGroup is an array of strings. This is not an error but we still warn
// the user and ignore the packageGroup keys.
if (!Array.isArray(packageGroup) || packageGroup.some(x => typeof x != 'string')) {
logger.warn(
`packageGroup metadata of package ${packageJson.name} is malformed. Ignoring.`,
);
} else {
result.packageGroup = packageGroup;
}
}
if (metadata['requirements']) {
const requirements = metadata['requirements'];
// Verify that requirements are
if (typeof requirements != 'object'
|| Array.isArray(requirements)
|| Object.keys(requirements).some(name => typeof requirements[name] != 'string')) {
logger.warn(
`requirements metadata of package ${packageJson.name} is malformed. Ignoring.`,
);
} else {
result.requirements = requirements;
}
}
if (metadata['migrations']) {
const migrations = metadata['migrations'];
if (typeof migrations != 'string') {
logger.warn(`migrations metadata of package ${packageJson.name} is malformed. Ignoring.`);
} else {
result.migrations = migrations;
}
}
return result;
}
function _usageMessage(
options: UpdateSchema,
infoMap: Map<string, PackageInfo>,
logger: logging.LoggerApi,
) {
const packageGroups = new Map<string, string>();
const packagesToUpdate = [...infoMap.entries()]
.map(([name, info]) => {
const tag = options.next
? (info.npmPackageJson['dist-tags']['next'] ? 'next' : 'latest') : 'latest';
const version = info.npmPackageJson['dist-tags'][tag];
const target = info.npmPackageJson.versions[version];
return {
name,
info,
version,
tag,
target,
};
})
.filter(({ name, info, version, target }) => {
return (target && semver.compare(info.installed.version, version) < 0);
})
.filter(({ target }) => {
return target['ng-update'];
})
.map(({ name, info, version, tag, target }) => {
// Look for packageGroup.
if (target['ng-update'] && target['ng-update']['packageGroup']) {
const packageGroup = target['ng-update']['packageGroup'];
const packageGroupName = target['ng-update']['packageGroupName']
|| target['ng-update']['packageGroup'][0];
if (packageGroupName) {
if (packageGroups.has(name)) {
return null;
}
packageGroup.forEach((x: string) => packageGroups.set(x, packageGroupName));
packageGroups.set(packageGroupName, packageGroupName);
name = packageGroupName;
}
}
let command = `ng update ${name}`;
if (tag == 'next') {
command += ' --next';
}
return [name, `${info.installed.version} -> ${version}`, command];
})
.filter(x => x !== null)
.sort((a, b) => a && b ? a[0].localeCompare(b[0]) : 0);
if (packagesToUpdate.length == 0) {
logger.info('We analyzed your package.json and everything seems to be in order. Good work!');
return of<void>(undefined);
}
logger.info(
'We analyzed your package.json, there are some packages to update:\n',
);
// Find the largest name to know the padding needed.
let namePad = Math.max(...[...infoMap.keys()].map(x => x.length)) + 2;
if (!Number.isFinite(namePad)) {
namePad = 30;
}
const pads = [namePad, 25, 0];
logger.info(
' '
+ ['Name', 'Version', 'Command to update'].map((x, i) => x.padEnd(pads[i])).join(''),
);
logger.info(' ' + '-'.repeat(pads.reduce((s, x) => s += x, 0) + 20));
packagesToUpdate.forEach(fields => {
if (!fields) {
return;
}
logger.info(' ' + fields.map((x, i) => x.padEnd(pads[i])).join(''));
});
logger.info('\n');
logger.info('There might be additional packages that are outdated.');
logger.info('Or run ng update --all to try to update all at the same time.\n');
return of<void>(undefined);
}
function _buildPackageInfo(
tree: Tree,
packages: Map<string, VersionRange>,
allDependencies: Map<string, VersionRange>,
npmPackageJson: NpmRepositoryPackageJson,
logger: logging.LoggerApi,
): PackageInfo {
const name = npmPackageJson.name;
const packageJsonRange = allDependencies.get(name);
if (!packageJsonRange) {
throw new SchematicsException(
`Package ${JSON.stringify(name)} was not found in package.json.`,
);
}
// Find out the currently installed version. Either from the package.json or the node_modules/
// TODO: figure out a way to read package-lock.json and/or yarn.lock.
let installedVersion: string | undefined;
const packageContent = tree.read(`/node_modules/${name}/package.json`);
if (packageContent) {
const content = JSON.parse(packageContent.toString()) as JsonSchemaForNpmPackageJsonFiles;
installedVersion = content.version;
}
if (!installedVersion) {
// Find the version from NPM that fits the range to max.
installedVersion = semver.maxSatisfying(
Object.keys(npmPackageJson.versions),
packageJsonRange,
);
}
const installedPackageJson = npmPackageJson.versions[installedVersion] || packageContent;
if (!installedPackageJson) {
throw new SchematicsException(
`An unexpected error happened; package ${name} has no version ${installedVersion}.`,
);
}
let targetVersion: VersionRange | undefined = packages.get(name);
if (targetVersion) {
if (npmPackageJson['dist-tags'][targetVersion]) {
targetVersion = npmPackageJson['dist-tags'][targetVersion] as VersionRange;
} else if (targetVersion == 'next') {
targetVersion = npmPackageJson['dist-tags']['latest'] as VersionRange;
} else {
targetVersion = semver.maxSatisfying(
Object.keys(npmPackageJson.versions),
targetVersion,
) as VersionRange;
}
}
if (targetVersion && semver.lte(targetVersion, installedVersion)) {
logger.debug(`Package ${name} already satisfied by package.json (${packageJsonRange}).`);
targetVersion = undefined;
}
const target: PackageVersionInfo | undefined = targetVersion
? {
version: targetVersion,
packageJson: npmPackageJson.versions[targetVersion],
updateMetadata: _getUpdateMetadata(npmPackageJson.versions[targetVersion], logger),
}
: undefined;
// Check if there's an installed version.
return {
name,
npmPackageJson,
installed: {
version: installedVersion as VersionRange,
packageJson: installedPackageJson,
updateMetadata: _getUpdateMetadata(installedPackageJson, logger),
},
target,
packageJsonRange,
};
}
function _buildPackageList(
options: UpdateSchema,
projectDeps: Map<string, VersionRange>,
logger: logging.LoggerApi,
): Map<string, VersionRange> {
// Parse the packages options to set the targeted version.
const packages = new Map<string, VersionRange>();
const commandLinePackages =
(options.packages && options.packages.length > 0)
? options.packages
: (options.all ? projectDeps.keys() : []);
for (const pkg of commandLinePackages) {
// Split the version asked on command line.
const m = pkg.match(/^((?:@[^/]{1,100}\/)?[^@]{1,100})(?:@(.{1,100}))?$/);
if (!m) {
logger.warn(`Invalid package argument: ${JSON.stringify(pkg)}. Skipping.`);
continue;
}
const [, npmName, maybeVersion] = m;
const version = projectDeps.get(npmName);
if (!version) {
logger.warn(`Package not installed: ${JSON.stringify(npmName)}. Skipping.`);
continue;
}
// Verify that people have an actual version in the package.json, otherwise (label or URL or
// gist or ...) we don't update it.
if (
version.startsWith('http:') // HTTP
|| version.startsWith('file:') // Local folder
|| version.startsWith('git:') // GIT url
|| version.match(/^\w{1,100}\/\w{1,100}/) // GitHub's "user/repo"
|| version.match(/^(?:\.{0,2}\/)\w{1,100}/) // Local folder, maybe relative.
) {
// We only do that for --all. Otherwise we have the installed version and the user specified
// it on the command line.
if (options.all) {
logger.warn(
`Package ${JSON.stringify(npmName)} has a custom version: `
+ `${JSON.stringify(version)}. Skipping.`,
);
continue;
}
}
packages.set(npmName, (maybeVersion || (options.next ? 'next' : 'latest')) as VersionRange);
}
return packages;
}
function _addPackageGroup(
packages: Map<string, VersionRange>,
allDependencies: ReadonlyMap<string, string>,
npmPackageJson: NpmRepositoryPackageJson,
logger: logging.LoggerApi,
): void {
const maybePackage = packages.get(npmPackageJson.name);
if (!maybePackage) {
return;
}
const version = npmPackageJson['dist-tags'][maybePackage] || maybePackage;
if (!npmPackageJson.versions[version]) {
return;
}
const ngUpdateMetadata = npmPackageJson.versions[version]['ng-update'];
if (!ngUpdateMetadata) {
return;
}
const packageGroup = ngUpdateMetadata['packageGroup'];
if (!packageGroup) {
return;
}
if (!Array.isArray(packageGroup) || packageGroup.some(x => typeof x != 'string')) {
logger.warn(`packageGroup metadata of package ${npmPackageJson.name} is malformed.`);
return;
}
packageGroup
.filter(name => !packages.has(name)) // Don't override names from the command line.
.filter(name => allDependencies.has(name)) // Remove packages that aren't installed.
.forEach(name => {
packages.set(name, maybePackage);
});
}
/**
* Add peer dependencies of packages on the command line to the list of packages to update.
* We don't do verification of the versions here as this will be done by a later step (and can
* be ignored by the --force flag).
* @private
*/
function _addPeerDependencies(
packages: Map<string, VersionRange>,
_allDependencies: ReadonlyMap<string, string>,
npmPackageJson: NpmRepositoryPackageJson,
_logger: logging.LoggerApi,
): void {
const maybePackage = packages.get(npmPackageJson.name);
if (!maybePackage) {
return;
}
const version = npmPackageJson['dist-tags'][maybePackage] || maybePackage;
if (!npmPackageJson.versions[version]) {
return;
}
const packageJson = npmPackageJson.versions[version];
const error = false;
for (const [peer, range] of Object.entries(packageJson.peerDependencies || {})) {
if (!packages.has(peer)) {
packages.set(peer, range as VersionRange);
}
}
if (error) {
throw new SchematicsException('An error occured, see above.');
}
}
function _getAllDependencies(tree: Tree): Map<string, VersionRange> {
const packageJsonContent = tree.read('/package.json');
if (!packageJsonContent) {
throw new SchematicsException('Could not find a package.json. Are you in a Node project?');
}
let packageJson: JsonSchemaForNpmPackageJsonFiles;
try {
packageJson = JSON.parse(packageJsonContent.toString()) as JsonSchemaForNpmPackageJsonFiles;
} catch (e) {
throw new SchematicsException('package.json could not be parsed: ' + e.message);
}
return new Map<string, VersionRange>([
...Object.entries(packageJson.peerDependencies || {}),
...Object.entries(packageJson.devDependencies || {}),
...Object.entries(packageJson.dependencies || {}),
] as [string, VersionRange][]);
}
function _formatVersion(version: string | undefined) {
if (version === undefined) {
return undefined;
}
if (!version.match(/^\d{1,30}\.\d{1,30}\.\d{1,30}/)) {
version += '.0';
}
if (!version.match(/^\d{1,30}\.\d{1,30}\.\d{1,30}/)) {
version += '.0';
}
if (!semver.valid(version)) {
throw new SchematicsException(`Invalid migration version: ${JSON.stringify(version)}`);
}
return version;
}
export default function(options: UpdateSchema): Rule {
if (!options.packages) {
// We cannot just return this because we need to fetch the packages from NPM still for the
// help/guide to show.
options.packages = [];
} else if (typeof options.packages == 'string') {
// If a string, then we should split it and make it an array.
options.packages = options.packages.split(/,/g);
}
if (options.migrateOnly && options.from) {
if (options.packages.length !== 1) {
throw new SchematicsException('--from requires that only a single package be passed.');
}
}
options.from = _formatVersion(options.from);
options.to = _formatVersion(options.to);
return (tree: Tree, context: SchematicContext) => {
const logger = context.logger;
const allDependencies = _getAllDependencies(tree);
const packages = _buildPackageList(options, allDependencies, logger);
return observableFrom([...allDependencies.keys()]).pipe(
// Grab all package.json from the npm repository. This requires a lot of HTTP calls so we
// try to parallelize as many as possible.
mergeMap(depName => getNpmPackageJson(depName, options.registry, logger)),
// Build a map of all dependencies and their packageJson.
reduce<NpmRepositoryPackageJson, Map<string, NpmRepositoryPackageJson>>(
(acc, npmPackageJson) => {
// If the package was not found on the registry. It could be private, so we will just
// ignore. If the package was part of the list, we will error out, but will simply ignore
// if it's either not requested (so just part of package.json. silently) or if it's a
// `--all` situation. There is an edge case here where a public package peer depends on a
// private one, but it's rare enough.
if (!npmPackageJson.name) {
if (packages.has(npmPackageJson.requestedName)) {
if (options.all) {
logger.warn(`Package ${JSON.stringify(npmPackageJson.requestedName)} was not `
+ 'found on the registry. Skipping.');
} else {
throw new SchematicsException(
`Package ${JSON.stringify(npmPackageJson.requestedName)} was not found on the `
+ 'registry. Cannot continue as this may be an error.');
}
}
} else {
acc.set(npmPackageJson.name, npmPackageJson);
}
return acc;
},
new Map<string, NpmRepositoryPackageJson>(),
),
map(npmPackageJsonMap => {
// Augment the command line package list with packageGroups and forward peer dependencies.
npmPackageJsonMap.forEach((npmPackageJson) => {
_addPackageGroup(packages, allDependencies, npmPackageJson, logger);
_addPeerDependencies(packages, allDependencies, npmPackageJson, logger);
});
// Build the PackageInfo for each module.
const packageInfoMap = new Map<string, PackageInfo>();
npmPackageJsonMap.forEach((npmPackageJson) => {
packageInfoMap.set(
npmPackageJson.name,
_buildPackageInfo(tree, packages, allDependencies, npmPackageJson, logger),
);
});
return packageInfoMap;
}),
switchMap(infoMap => {
// Now that we have all the information, check the flags.
if (packages.size > 0) {
if (options.migrateOnly && options.from && options.packages) {
return _migrateOnly(
infoMap.get(options.packages[0]),
context,
options.from,
options.to,
);
}
const sublog = new logging.LevelCapLogger(
'validation',
logger.createChild(''),
'warn',
);
_validateUpdatePackages(infoMap, options.force, sublog);
return _performUpdate(tree, context, infoMap, logger, options.migrateOnly);
} else {
return _usageMessage(options, infoMap, logger);
}
}),
switchMap(() => of(tree)),
);
};
}