Add a Pub validator for READMEs that are invalid utf-8.

utils/pub/entrypoint.dart

 // 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.
 
 library entrypoint;
 
 import 'dart:async';
 import 'io.dart';
 import 'lock_file.dart';
 import 'log.dart' as log;
 import 'package.dart';
 import 'system_cache.dart';
 import 'utils.dart';
 import 'version.dart';
 import 'version_solver.dart';
 
+final _README_REGEXP = new RegExp(r"^README($|\.)", caseSensitive: false);
+
 /// Pub operates over a directed graph of dependencies that starts at a root
 /// "entrypoint" package. This is typically the package where the current
 /// working directory is located. An entrypoint knows the [root] package it is
 /// associated with and is responsible for managing the "packages" directory
 /// for it.
 ///
 /// That directory contains symlinks to all packages used by an app. These links
 /// point either to the [SystemCache] or to some other location on the local
 /// filesystem.
 ///
@@ skipping 20 matching lines @@
   /// Loads the entrypoint from a package at [rootDir].
   static Future<Entrypoint> load(String rootDir, SystemCache cache) {
     return Package.load(null, rootDir, cache.sources).then((package) =>
         new Entrypoint(package, cache));
   }
 
   // TODO(rnystrom): Make this path configurable.
   /// The path to this "packages" directory.
   String get path => join(root.dir, 'packages');
 
+  /// Returns the path to the README file at the root of the entrypoint, or null
+  /// if no README file is found. If multiple READMEs are found, this uses the
+  /// same conventions as pub.dartlang.org for choosing the primary one: the
+  /// README with the fewest extensions that is lexically ordered first is
+  /// chosen.

[Bob Nystrom, 2013/01/31 19:08:29]

How about moving this to Package? It's not specific to the entrypoint.

[nweiz, 2013/01/31 21:39:10]

Done.

+  Future<String> get readmePath {
+    return listDir(root.dir).then((entries) {
+      var readmes = entries.where((entry) => entry.contains(_README_REGEXP));
+      if (readmes.isEmpty) return;
+
+      return readmes.min((readme1, readme2) {
+        var extensions1 = ".".allMatches(readme1).length;
+        var extensions2 = ".".allMatches(readme2).length;
+        var comparison = extensions1.compareTo(extensions2);
+        if (comparison != 0) return comparison;
+        return readme1.compareTo(readme2);
+      });
+    });
+  }
+
   /// Ensures that the package identified by [id] is installed to the directory.
   /// Returns the resolved [PackageId].
   ///
   /// If this completes successfully, the package is guaranteed to be importable
   /// using the `package:` scheme.
   ///
   /// This will automatically install the package to the system-wide cache as
   /// well if it requires network access to retrieve (specifically, if
   /// `id.source.shouldCache` is true).
   ///
@@ skipping 171 matching lines @@
 
   /// Creates a symlink to the `packages` directory in [dir] if none exists.
   Future _linkSecondaryPackageDir(String dir) {
     var to = join(dir, 'packages');
     return exists(to).then((exists) {
       if (exists) return;
       return createSymlink(path, to);
     });
   }
 }