Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1382)

Unified Diff: sdk/lib/_internal/pub/lib/src/validator/dependency.dart

Issue 173113004: Improve the "pub lish" warnings about dependency constraints. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: code review Created 6 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | sdk/lib/_internal/pub/lib/src/version.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sdk/lib/_internal/pub/lib/src/validator/dependency.dart
diff --git a/sdk/lib/_internal/pub/lib/src/validator/dependency.dart b/sdk/lib/_internal/pub/lib/src/validator/dependency.dart
index 1715240ca08c11e7573594b15558168ecfe03f61..aa216713e96412066dee31028fe6787111ec4a6f 100644
--- a/sdk/lib/_internal/pub/lib/src/validator/dependency.dart
+++ b/sdk/lib/_internal/pub/lib/src/validator/dependency.dart
@@ -7,6 +7,7 @@ library pub.validator.dependency;
import 'dart:async';
import '../entrypoint.dart';
+import '../log.dart' as log;
import '../package.dart';
import '../validator.dart';
import '../version.dart';
@@ -22,7 +23,17 @@ class DependencyValidator extends Validator {
return _warnAboutSource(dependency);
}
- if (dependency.constraint.isAny) _warnAboutConstraint(dependency);
+ if (dependency.constraint.isAny) {
+ _warnAboutNoConstraint(dependency);
+ } else if (dependency.constraint is Version) {
+ _warnAboutSingleVersionConstraint(dependency);
+ } else if (dependency.constraint is VersionRange) {
+ if (dependency.constraint.min == null) {
+ _warnAboutNoConstraintLowerBound(dependency);
+ } else if (dependency.constraint.max == null) {
+ _warnAboutNoConstraintUpperBound(dependency);
+ }
+ }
return new Future.value();
});
@@ -63,7 +74,7 @@ class DependencyValidator extends Validator {
}
/// Warn that dependencies should have version constraints.
- void _warnAboutConstraint(PackageDep dep) {
+ void _warnAboutNoConstraint(PackageDep dep) {
var lockFile = entrypoint.loadLockFile();
var message = 'Your dependency on "${dep.name}" should have a version '
'constraint.';
@@ -75,15 +86,69 @@ class DependencyValidator extends Validator {
' ${dep.name}: ${_constraintForVersion(locked.version)}\n';
}
warnings.add("$message\n"
- "Without a constraint, you're promising to support all future "
- "versions of ${dep.name}.");
+ 'Without a constraint, you\'re promising to support ${log.bold("all")} '
+ 'future versions of "${dep.name}".');
+ }
+
+ // Warn that dependencies should allow more than a single version.
+ void _warnAboutSingleVersionConstraint(PackageDep dep) {
+ warnings.add(
+ 'Your dependency on "${dep.name}" should allow more than one version. '
+ 'For example:\n'
+ '\n'
+ 'dependencies:\n'
+ ' ${dep.name}: ${_constraintForVersion(dep.constraint)}\n'
+ '\n'
+ 'Constraints that are too tight will make it difficult for people to '
+ 'use your package\n'
+ 'along with other packages that also depend on "${dep.name}".');
+ }
+
+ // Warn that dependencies should have lower bounds on their constraints.
+ void _warnAboutNoConstraintLowerBound(PackageDep dep) {
+ var message = 'Your dependency on "${dep.name}" should have a lower bound.';
+ var locked = entrypoint.loadLockFile().packages[dep.name];
+ if (locked != null) {
+ var constraint;
+ if (locked.version == dep.constraint.max) {
+ constraint = _constraintForVersion(locked.version);
+ } else {
+ constraint = '">=${locked.version} ${dep.constraint}"';
+ }
+
+ message = '$message For example:\n'
+ '\n'
+ 'dependencies:\n'
+ ' ${dep.name}: $constraint\n';
+ }
+ warnings.add("$message\n"
+ 'Without a constraint, you\'re promising to support ${log.bold("all")} '
+ 'previous versions of "${dep.name}".');
+ }
+
+ // Warn that dependencies should have upper bounds on their constraints.
+ void _warnAboutNoConstraintUpperBound(PackageDep dep) {
+ warnings.add(
+ 'Your dependency on "${dep.name}" should have an upper bound. For '
+ 'example:\n'
+ '\n'
+ 'dependencies:\n'
+ ' ${dep.name}: "${dep.constraint} '
+ '${_upperBoundForVersion(dep.constraint.min)}"\n'
+ '\n'
+ 'Without an upper bound, you\'re promising to support '
+ '${log.bold("all")} future versions of ${dep.name}.');
}
/// Returns the suggested version constraint for a dependency that was tested
/// against [version].
- String _constraintForVersion(Version version) {
- if (version.major != 0) return '">=$version <${version.major + 1}.0.0"';
- return '">=$version <${version.major}.${version.minor}.'
- '${version.patch + 1}"';
+ String _constraintForVersion(Version version) =>
+ '">=$version ${_upperBoundForVersion(version)}"';
+
+ /// Returns the suggested upper bound for a dependency that was tested against
+ /// [version].
+ String _upperBoundForVersion(Version version) {
+ if (version.major != 0) return '<${version.major + 1}.0.0';
+ return '<${version.major}.${version.minor + 1}.0';
}
}
« no previous file with comments | « no previous file | sdk/lib/_internal/pub/lib/src/version.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698