-
Notifications
You must be signed in to change notification settings - Fork 223
/
pubspec.dart
836 lines (764 loc) · 26.6 KB
/
pubspec.dart
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
// Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'package:collection/collection.dart' hide mapMap;
import 'package:path/path.dart' as p;
import 'package:pub_semver/pub_semver.dart';
import 'package:source_span/source_span.dart';
import 'package:yaml/yaml.dart';
import 'exceptions.dart';
import 'io.dart';
import 'language_version.dart';
import 'package_name.dart';
import 'pubspec_parse.dart';
import 'sdk.dart';
import 'source.dart';
import 'source/root.dart';
import 'system_cache.dart';
export 'pubspec_parse.dart' hide PubspecBase;
/// The default SDK upper bound constraint for packages that don't declare one.
///
/// This provides a sane default for packages that don't have an upper bound.
final VersionRange _defaultUpperBoundSdkConstraint =
VersionConstraint.parse('<2.0.0') as VersionRange;
/// The parsed contents of a pubspec file.
///
/// The fields of a pubspec are, for the most part, validated when they're first
/// accessed. This allows a partially-invalid pubspec to be used if only the
/// valid portions are relevant. To get a list of all errors in the pubspec, use
/// [allErrors].
class Pubspec extends PubspecBase {
// If a new lazily-initialized field is added to this class and the
// initialization can throw a [PubspecException], that error should also be
// exposed through [allErrors].
/// The fields of [pubspecOverridesFilename]. `null` if no such file exists or has
/// to be considered.
final YamlMap? _overridesFileFields;
String? get _packageName => fields['name'] != null ? name : null;
final bool dependencyOverridesFromOverridesFile;
/// The name of the manifest file.
static const pubspecYamlFilename = 'pubspec.yaml';
/// The filename of the pubspec overrides file.
///
/// This file can contain dependency_overrides that override those in
/// pubspec.yaml.
static const pubspecOverridesFilename = 'pubspec_overrides.yaml';
/// The registry of sources to use when parsing [dependencies] and
/// [devDependencies].
///
/// This will be null if this was created using [Pubspec] or [Pubspec.empty].
final SourceRegistry sources;
/// It is used to resolve relative paths. And to resolve path-descriptions
/// from a git dependency as git-descriptions.
final Description _containingDescription;
/// Directories of packages that should resolve together with this package.
late List<String> workspace = () {
final result = <String>[];
final r = fields.nodes['workspace'];
if (r != null && !languageVersion.supportsWorkspaces) {
_error(
'`workspace` and `resolution` requires at least language version ${LanguageVersion.firstVersionWithWorkspaces}',
r.span,
);
}
if (r == null || r.value == null) return <String>[];
if (r is! YamlList) {
_error('"workspace" must be a list of strings', r.span);
}
for (final t in r.nodes) {
final value = t.value;
if (value is! String) {
_error('"workspace" must be a list of strings', t.span);
}
if (!p.isRelative(value)) {
_error('"workspace" members must be relative paths', t.span);
}
if (p.equals(value, '.') || !p.isWithin('.', value)) {
_error('"workspace" members must be subdirectories', t.span);
}
result.add(value);
}
return result;
}();
/// The resolution mode.
late Resolution resolution = () {
final r = fields.nodes['resolution'];
if (r != null && !languageVersion.supportsWorkspaces) {
_error(
'`workspace` and `resolution` requires at least language version ${LanguageVersion.firstVersionWithWorkspaces}',
r.span,
);
}
return switch (r?.value) {
null => Resolution.none,
'local' => Resolution.local,
'workspace' => Resolution.workspace,
'external' => Resolution.external,
_ => _error(
'"resolution" must be one of `workspace`, `local`, `external`',
r!.span,
)
};
}();
/// The additional packages this package depends on.
Map<String, PackageRange> get dependencies =>
_dependencies ??= _parseDependencies(
'dependencies',
fields.nodes['dependencies'],
sources,
languageVersion,
_packageName,
_containingDescription,
);
Map<String, PackageRange>? _dependencies;
/// The packages this package depends on when it is the root package.
Map<String, PackageRange> get devDependencies =>
_devDependencies ??= _parseDependencies(
'dev_dependencies',
fields.nodes['dev_dependencies'],
sources,
languageVersion,
_packageName,
_containingDescription,
);
Map<String, PackageRange>? _devDependencies;
/// The dependency constraints that this package overrides when it is the
/// root package.
///
/// Dependencies here will replace any dependency on a package with the same
/// name anywhere in the dependency graph.
///
/// These can occur both in the pubspec.yaml file and the [pubspecOverridesFilename].
Map<String, PackageRange> get dependencyOverrides {
if (_dependencyOverrides != null) return _dependencyOverrides!;
final pubspecOverridesFields = _overridesFileFields;
if (pubspecOverridesFields != null) {
pubspecOverridesFields.nodes.forEach((key, _) {
final keyNode = key as YamlNode;
if (!const {'dependency_overrides'}.contains(keyNode.value)) {
throw SourceSpanApplicationException(
'pubspec_overrides.yaml only supports the `dependency_overrides` field.',
keyNode.span,
);
}
});
if (pubspecOverridesFields.containsKey('dependency_overrides')) {
_dependencyOverrides = _parseDependencies(
'dependency_overrides',
pubspecOverridesFields.nodes['dependency_overrides'],
sources,
languageVersion,
_packageName,
_containingDescription,
fileType: _FileType.pubspecOverrides,
);
}
}
return _dependencyOverrides ??= _parseDependencies(
'dependency_overrides',
fields.nodes['dependency_overrides'],
sources,
languageVersion,
_packageName,
_containingDescription,
);
}
Map<String, PackageRange>? _dependencyOverrides;
SdkConstraint get dartSdkConstraint => sdkConstraints['dart']!;
/// A map from SDK identifiers to constraints on those SDK versions.
late final Map<String, SdkConstraint> sdkConstraints =
_givenSdkConstraints ?? UnmodifiableMapView(_parseEnvironment(fields));
final Map<String, SdkConstraint>? _givenSdkConstraints;
/// Whether or not to apply the [_defaultUpperBoundsSdkConstraint] to this
/// pubspec.
final bool _includeDefaultSdkConstraint;
/// Parses the "environment" field in [parent] and returns a map from SDK
/// identifiers to constraints on those SDKs.
Map<String, SdkConstraint> _parseEnvironment(YamlMap parent) {
final yaml = parent['environment'];
final VersionConstraint originalDartSdkConstraint;
if (yaml == null) {
originalDartSdkConstraint = VersionConstraint.any;
} else if (yaml is! YamlMap) {
_error(
'"environment" field must be a map.',
parent.nodes['environment']!.span,
);
} else {
originalDartSdkConstraint = _parseVersionConstraint(
yaml.nodes['sdk'],
_packageName,
_FileType.pubspec,
);
}
final constraints = {
'dart': SdkConstraint.interpretDartSdkConstraint(
originalDartSdkConstraint,
defaultUpperBoundConstraint: _includeDefaultSdkConstraint
? _defaultUpperBoundSdkConstraint
: null,
),
};
if (yaml is YamlMap) {
yaml.nodes.forEach((nameNode, constraintNode) {
if (nameNode is! YamlNode) throw AssertionError('Bad state');
final name = nameNode.value;
if (name is! String) {
_error('SDK names must be strings.', nameNode.span);
} else if (name == 'dart') {
_error('Use "sdk" to for Dart SDK constraints.', nameNode.span);
}
if (name == 'sdk') return;
final constraint = _parseVersionConstraint(
constraintNode,
_packageName,
_FileType.pubspec,
);
constraints[name] = name == 'flutter'
? SdkConstraint.interpretFlutterSdkConstraint(constraint)
: SdkConstraint(constraint);
});
}
return constraints;
}
/// The language version implied by the sdk constraint.
LanguageVersion get languageVersion {
return LanguageVersion.fromSdkConstraint(
dartSdkConstraint.originalConstraint,
);
}
/// Loads the pubspec for a package located in [packageDir].
///
/// If [expectedName] is passed and the pubspec doesn't have a matching name
/// field, this will throw a [SourceSpanApplicationException].
///
/// If [allowOverridesFile] is `true` [pubspecOverridesFilename] is loaded and
/// is allowed to override dependency_overrides from `pubspec.yaml`.
factory Pubspec.load(
String packageDir,
SourceRegistry sources, {
String? expectedName,
bool allowOverridesFile = false,
required Description containingDescription,
}) {
final pubspecPath = p.join(packageDir, pubspecYamlFilename);
final overridesPath = p.join(packageDir, pubspecOverridesFilename);
if (!fileExists(pubspecPath)) {
throw FileException(
// Make the package dir absolute because for the entrypoint it'll just
// be ".", which may be confusing.
'Could not find a file named "pubspec.yaml" in '
'"${canonicalize(packageDir)}".',
pubspecPath,
);
}
final overridesFileContents =
allowOverridesFile && fileExists(overridesPath)
? readTextFile(overridesPath)
: null;
return Pubspec.parse(
readTextFile(pubspecPath),
sources,
expectedName: expectedName,
location: p.toUri(pubspecPath),
overridesFileContents: overridesFileContents,
overridesLocation: p.toUri(overridesPath),
containingDescription: containingDescription,
);
}
/// Convenience helper to pass to [Package.load].
static Pubspec Function(
String dir, {
String? expectedName,
required bool withPubspecOverrides,
}) loadRootWithSources(SourceRegistry sources) {
return (
String dir, {
String? expectedName,
required bool withPubspecOverrides,
}) =>
Pubspec.load(
dir,
sources,
expectedName: expectedName,
allowOverridesFile: withPubspecOverrides,
containingDescription: RootDescription(dir),
);
}
Pubspec(
String name, {
Version? version,
Iterable<PackageRange>? dependencies,
Iterable<PackageRange>? devDependencies,
Iterable<PackageRange>? dependencyOverrides,
Map? fields,
SourceRegistry? sources,
Map<String, SdkConstraint>? sdkConstraints,
this.workspace = const <String>[],
this.dependencyOverridesFromOverridesFile = false,
this.resolution = Resolution.none,
}) : _dependencies = dependencies == null
? null
: {for (final d in dependencies) d.name: d},
_devDependencies = devDependencies == null
? null
: {for (final d in devDependencies) d.name: d},
_dependencyOverrides = dependencyOverrides == null
? null
: {for (final d in dependencyOverrides) d.name: d},
_givenSdkConstraints = sdkConstraints ??
UnmodifiableMapView({'dart': SdkConstraint(VersionConstraint.any)}),
_includeDefaultSdkConstraint = false,
sources = sources ??
((String? name) => throw StateError('No source registry given')),
_overridesFileFields = null,
// This is a dummy value.
// Dependencies should already be resolved, so we never need to do relative resolutions.
_containingDescription = RootDescription('.'),
super(
fields == null ? YamlMap() : YamlMap.wrap(fields),
name: name,
version: version,
);
/// Returns a Pubspec object for an already-parsed map representing its
/// contents.
///
/// If [expectedName] is passed and the pubspec doesn't have a matching name
/// field, this will throw a [PubspecError].
///
/// [location] is the location from which this pubspec was loaded.
Pubspec.fromMap(
Map fields,
this.sources, {
YamlMap? overridesFields,
String? expectedName,
Uri? location,
required Description containingDescription,
}) : _overridesFileFields = overridesFields,
_includeDefaultSdkConstraint = true,
_givenSdkConstraints = null,
dependencyOverridesFromOverridesFile = overridesFields != null &&
overridesFields.containsKey('dependency_overrides'),
_containingDescription = containingDescription,
super(
fields is YamlMap
? fields
: YamlMap.wrap(fields, sourceUrl: location),
) {
// If [expectedName] is passed, ensure that the actual 'name' field exists
// and matches the expectation.
if (expectedName == null) return;
if (name == expectedName) return;
throw SourceSpanApplicationException(
'"name" field doesn\'t match expected name '
'"$expectedName".',
this.fields.nodes['name']!.span,
);
}
/// Parses the pubspec stored at [location] whose text is [contents].
///
/// If the pubspec doesn't define a version for itself, it defaults to
/// [Version.none].
factory Pubspec.parse(
String contents,
SourceRegistry sources, {
String? expectedName,
Uri? location,
String? overridesFileContents,
Uri? overridesLocation,
required Description containingDescription,
}) {
late final YamlMap pubspecMap;
YamlMap? overridesFileMap;
try {
pubspecMap = _ensureMap(loadYamlNode(contents, sourceUrl: location));
if (overridesFileContents != null) {
overridesFileMap = _ensureMap(
loadYamlNode(overridesFileContents, sourceUrl: overridesLocation),
);
}
} on YamlException catch (error) {
throw SourceSpanApplicationException(error.message, error.span);
}
return Pubspec.fromMap(
pubspecMap,
sources,
overridesFields: overridesFileMap,
expectedName: expectedName,
location: location,
containingDescription: containingDescription,
);
}
Pubspec copyWith({
String? name,
Version? version,
Iterable<PackageRange>? dependencies,
Iterable<PackageRange>? devDependencies,
Iterable<PackageRange>? dependencyOverrides,
Map? fields,
Map<String, SdkConstraint>? sdkConstraints,
List<String>? workspace,
//this.dependencyOverridesFromOverridesFile = false,
Resolution? resolution,
}) {
return Pubspec(
name ?? this.name,
version: version ?? this.version,
dependencies: dependencies ?? this.dependencies.values,
devDependencies: devDependencies ?? this.devDependencies.values,
dependencyOverrides:
dependencyOverrides ?? this.dependencyOverrides.values,
sdkConstraints: sdkConstraints ?? this.sdkConstraints,
workspace: workspace ?? this.workspace,
resolution: resolution ?? this.resolution,
);
}
/// Ensures that [node] is a mapping.
///
/// If [node] is already a map it is returned.
/// If [node] is yaml-null an empty map is returned.
/// Otherwise an exception is thrown.
static YamlMap _ensureMap(YamlNode node) {
if (node is YamlScalar && node.value == null) {
return YamlMap(sourceUrl: node.span.sourceUrl);
} else if (node is YamlMap) {
return node;
} else {
throw SourceSpanApplicationException(
'The pubspec must be a YAML mapping.',
node.span,
);
}
}
List<SourceSpanApplicationException> _collectErrorsFor(
List<dynamic Function()> toCheck,
) {
final errors = <SourceSpanApplicationException>[];
void collectError(void Function() fn) {
try {
fn();
} on SourceSpanApplicationException catch (e) {
errors.add(e);
}
}
for (final fn in toCheck) {
collectError(fn);
}
return errors;
}
/// Returns a list of errors relevant to consuming this pubspec as a dependency
///
/// This will return at most one error for each field.
List<SourceSpanApplicationException> get dependencyErrors =>
_collectErrorsFor([
() => name,
() => version,
() => dependencies,
() => executables,
() => ignoredAdvisories,
]);
/// Returns a list of most errors in this pubspec.
///
/// This will return at most one error for each field.
List<SourceSpanApplicationException> get allErrors => _collectErrorsFor([
() => name,
() => version,
() => dependencies,
() => devDependencies,
() => publishTo,
() => executables,
() => falseSecrets,
() => sdkConstraints,
() => ignoredAdvisories,
]);
/// Returns the type of dependency from this package onto [name].
DependencyType dependencyType(String? name) {
if (dependencies.containsKey(name)) {
return DependencyType.direct;
} else if (devDependencies.containsKey(name)) {
return DependencyType.dev;
} else {
return DependencyType.none;
}
}
}
/// The type of dependency from one package to another.
enum DependencyType {
direct,
dev,
none;
@override
String toString() => name;
}
/// Parses the dependency field named [field], and returns the corresponding
/// map of dependency names to dependencies.
Map<String, PackageRange> _parseDependencies(
String field,
YamlNode? node,
SourceRegistry sources,
LanguageVersion languageVersion,
String? packageName,
Description containingDescription, {
_FileType fileType = _FileType.pubspec,
}) {
final dependencies = <String, PackageRange>{};
// Allow an empty dependencies key.
if (node == null || node.value == null) return dependencies;
if (node is! YamlMap) {
_error('"$field" field must be a map.', node.span);
}
final nonStringNode = node.nodes.keys
.firstWhereOrNull((e) => e is YamlScalar && e.value is! String);
if (nonStringNode != null) {
_error(
'A dependency name must be a string.',
(nonStringNode as YamlNode).span,
);
}
node.nodes.forEach(
(nameNode, specNode) {
final name = (nameNode as YamlNode).value;
if (name is! String) {
_error('A dependency name must be a string.', nameNode.span);
}
if (!packageNameRegExp.hasMatch(name)) {
_error('Not a valid package name.', nameNode.span);
}
final spec = specNode.value;
if (packageName != null && name == packageName) {
_error('A package may not list itself as a dependency.', nameNode.span);
}
final String? sourceName;
VersionConstraint versionConstraint = VersionRange();
YamlNode? descriptionNode;
if (spec == null) {
sourceName = null;
} else if (spec is String) {
sourceName = null;
versionConstraint =
_parseVersionConstraint(specNode, packageName, fileType);
} else if (specNode is YamlMap) {
// Don't write to the immutable YAML map.
final versionNode = specNode.nodes['version'];
versionConstraint = _parseVersionConstraint(
versionNode,
packageName,
fileType,
);
final otherEntries = specNode.nodes.entries
.where((entry) => entry.key.value != 'version')
.toList();
if (otherEntries.length > 1) {
_error('A dependency may only have one source.', specNode.span);
} else if (otherEntries.isEmpty) {
// Default to a hosted dependency if no source is specified.
sourceName = 'hosted';
} else {
switch (otherEntries.single) {
case MapEntry(
key: YamlScalar(value: final String s),
value: final d
):
sourceName = s;
descriptionNode = d;
case MapEntry(key: final k, value: _):
_error(
'A source name must be a string.',
(k as YamlNode).span,
);
}
}
} else {
_error(
'A dependency specification must be a string or a mapping.',
specNode.span,
);
}
// Let the source validate the description.
final ref = _wrapFormatException(
'description',
descriptionNode?.span,
() {
return sources(sourceName).parseRef(
name,
descriptionNode?.value,
containingDescription: containingDescription,
languageVersion: languageVersion,
);
},
packageName,
fileType,
targetPackage: name,
);
dependencies[name] = ref.withConstraint(versionConstraint);
},
);
return dependencies;
}
/// Parses [node] to a [VersionConstraint].
///
/// If or [defaultUpperBoundConstraint] is specified then it will be set as the
/// max constraint if the original constraint doesn't have an upper bound and it
/// is compatible with [defaultUpperBoundConstraint].
VersionConstraint _parseVersionConstraint(
YamlNode? node,
String? packageName,
_FileType fileType,
) {
if (node?.value == null) {
return VersionConstraint.any;
}
final value = node!.value;
if (value is! String) {
_error('A version constraint must be a string.', node.span);
}
return _wrapFormatException(
'version constraint',
node.span,
() {
final constraint = VersionConstraint.parse(value);
return constraint;
},
packageName,
fileType,
);
}
/// Runs [fn] and wraps any [FormatException] it throws in a
/// [SourceSpanApplicationException].
///
/// [description] should be a noun phrase that describes whatever's being
/// parsed or processed by [fn]. [span] should be the location of whatever's
/// being processed within the pubspec.
///
/// If [targetPackage] is provided, the value is used to describe the
/// dependency that caused the problem.
T _wrapFormatException<T>(
String description,
SourceSpan? span,
T Function() fn,
String? packageName,
_FileType fileType, {
String? targetPackage,
}) {
try {
return fn();
} on FormatException catch (e) {
// If we already have a pub exception with a span, re-use that
if (e is SourceSpanApplicationException) rethrow;
var msg = 'Invalid $description';
final typeName = _fileTypeName(fileType);
if (targetPackage != null) {
msg = '$msg in the "$packageName" $typeName on the "$targetPackage" '
'dependency';
}
msg = '$msg: ${e.message}';
_error(msg, span);
}
}
/// Throws a [SourceSpanApplicationException] with the given message.
Never _error(String message, SourceSpan? span) {
throw SourceSpanApplicationException(message, span);
}
enum _FileType {
pubspec,
pubspecOverrides,
}
String _fileTypeName(_FileType type) {
switch (type) {
case _FileType.pubspec:
return 'pubspec';
case _FileType.pubspecOverrides:
return 'pubspec override';
}
}
/// There are special rules or interpreting SDK constraints, we take care to
/// save the original constraint as found in pubspec.yaml.
class SdkConstraint {
/// The constraint as written in the pubspec.yaml.
final VersionConstraint originalConstraint;
/// The constraint as interpreted by pub.
final VersionConstraint effectiveConstraint;
SdkConstraint(
this.effectiveConstraint, {
VersionConstraint? originalConstraint,
}) : originalConstraint = originalConstraint ?? effectiveConstraint;
/// Implement support for down to 2.12 in the dart 3 series. Note that this
/// function has to be be idempotent, because we apply it both when we write
/// and read lock-file constraints, so applying this function a second time
/// should have no further effect.
factory SdkConstraint.interpretDartSdkConstraint(
VersionConstraint originalConstraint, {
required VersionConstraint? defaultUpperBoundConstraint,
}) {
var constraint = originalConstraint;
if (defaultUpperBoundConstraint != null &&
constraint is VersionRange &&
constraint.max == null &&
defaultUpperBoundConstraint.allowsAny(constraint)) {
constraint = VersionConstraint.intersection(
[constraint, defaultUpperBoundConstraint],
);
}
// If a package is null safe it should also be compatible with dart 3.
// Therefore we rewrite a null-safety enabled constraint with the upper
// bound <3.0.0 to be have upper bound <4.0.0
//
// Only do this rewrite after dart 3.
if (sdk.version.major >= 3 &&
constraint is VersionRange &&
LanguageVersion.fromSdkConstraint(constraint) >=
LanguageVersion.firstVersionWithNullSafety &&
// <3.0.0 is parsed into a max of 3.0.0-0, so that is what we look for
// here.
constraint.max == Version(3, 0, 0).firstPreRelease &&
constraint.includeMax == false) {
constraint = VersionRange(
min: constraint.min,
includeMin: constraint.includeMin,
// We don't have to use .firstPreRelease as the constructor will do that
// if needed.
max: Version(4, 0, 0),
);
}
return SdkConstraint(constraint, originalConstraint: originalConstraint);
}
// Flutter constraints get special treatment, as Flutter won't be using
// semantic versioning to mark breaking releases. We simply ignore upper
// bounds.
factory SdkConstraint.interpretFlutterSdkConstraint(
VersionConstraint constraint,
) {
if (constraint is VersionRange) {
return SdkConstraint(
VersionRange(min: constraint.min, includeMin: constraint.includeMin),
originalConstraint: constraint,
);
}
return SdkConstraint(constraint);
}
/// The language version of a constraint is determined from how it is written.
LanguageVersion get languageVersion =>
LanguageVersion.fromSdkConstraint(originalConstraint);
// We currently don't call this anywhere - so this is only for debugging
// purposes.
@override
String toString() {
if (effectiveConstraint != originalConstraint) {
return '$originalConstraint (interpreted as $effectiveConstraint)';
}
return effectiveConstraint.toString();
}
@override
bool operator ==(Object other) =>
other is SdkConstraint &&
other.effectiveConstraint == effectiveConstraint &&
other.originalConstraint == originalConstraint;
@override
int get hashCode => Object.hash(effectiveConstraint, originalConstraint);
}
enum Resolution {
external,
workspace,
local,
none,
}