add --preview flag to publish command

utils/pub/command_lish.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 command_lish;
 
 import 'dart:async';
 import 'dart:io';
 import 'dart:json';
 import 'dart:uri';
@@ skipping 14 matching lines @@
 /// Handles the `lish` and `publish` pub commands.
 class LishCommand extends PubCommand {
   final description = "Publish the current package to pub.dartlang.org.";
   final usage = "pub publish [options]";
   final aliases = const ["lish", "lush"];
 
   ArgParser get commandParser {
     var parser = new ArgParser();
     // TODO(nweiz): Use HostedSource.defaultUrl as the default value once we use
     // dart:io for HTTPS requests.
+    parser.addFlag('dry-run', abbr: 'n', negatable: false,
+        help: "Preview publishing the package\n" 
+              "Validate but do not publish the package");

[Bob Nystrom, 2013/02/12 01:00:41]

You can remove the "Preview..." line.

[keertip, 2013/02/12 05:20:20]

Done.

     parser.addOption('server', defaultsTo: 'https://pub.dartlang.org',
         help: 'The package server to which to upload this package');
     return parser;
   }
 
   /// The URL of the server to which to upload the package.
   Uri get server => Uri.parse(commandOptions['server']);
 
   Future _publish(packageBytes) {
     var cloudStorageUrl;
@@ skipping 48 matching lines @@
       var package = entrypoint.root;
       log.message(
           'Publishing "${package.name}" ${package.version}:\n'
           '${generateTree(files)}');
 
       return createTarGz(files, baseDir: entrypoint.root.dir);
     }).then((stream) => stream.toBytes());
 
     // Validate the package.
     return _validate(packageBytesFuture.then((bytes) => bytes.length))
-        .then((_) => packageBytesFuture).then(_publish);
+        .then((validate) {

[Bob Nystrom, 2013/02/12 01:00:41]

"validate" -> "isValid"

[keertip, 2013/02/12 05:20:20]

Done.

+           if (validate) return packageBytesFuture.then(_publish);
+           });

[Bob Nystrom, 2013/02/12 01:00:41]

The styling of this is a bit strange. How about:

return _validate(...
    .then((isValid) {
  if (isValid) return package...
});

[keertip, 2013/02/12 05:20:20]

Done.

   }
-
+  
   /// The basenames of files that are automatically excluded from archives.
   final _BLACKLISTED_FILES = const ['pubspec.lock'];
 
   /// The basenames of directories that are automatically excluded from
   /// archives.
   final _BLACKLISTED_DIRS = const ['packages'];
 
   /// Returns a list of files that should be included in the published package.
   /// If this is a Git repository, this will respect .gitignore; otherwise, it
   /// will return all non-hidden files.
@@ skipping 23 matching lines @@
   }
 
   /// Returns the value associated with [key] in [map]. Throws a user-friendly
   /// error if [map] doens't contain [key].
   _expectField(Map map, String key, http.Response response) {
     if (map.containsKey(key)) return map[key];
     invalidServerResponse(response);
   }
 
   /// Validates the package. Throws an exception if it's invalid.
-  Future _validate(Future<int> packageSize) {
+  Future<bool> _validate(Future<int> packageSize) {
     return Validator.runAll(entrypoint, packageSize).then((pair) {
       var errors = pair.first;
       var warnings = pair.last;
 
       if (!errors.isEmpty) {
         throw "Sorry, your package is missing "
             "${(errors.length > 1) ? 'some requirements' : 'a requirement'} "
             "and can't be published yet.\nFor more information, see: "
             "http://pub.dartlang.org/doc/pub-lish.html.\n";

[Bob Nystrom, 2013/02/12 01:00:41]

Instead of throwing, just use log.error() to print the message then return
false.

[keertip, 2013/02/12 05:20:20]

With this change, publish will return with exitcode 0 even when there are erros
in the package. Would this be ok? Do we want to have a different exitcode to
indicate errors?

On 2013/02/12 01:00:41, Bob Nystrom wrote:

[Bob Nystrom, 2013/02/12 19:00:57]

Hmm. Good point. I think I'm OK with that for now at least.

       }
 
+      if (commandOptions['dry-run']){
+        var s = warnings.length == 1 ? '' : 's';
+        log.warning("Package has ${warnings.length} warning$s.");
+        return new Future.immediate(false);

[Bob Nystrom, 2013/02/12 01:00:41]

You don't need Future here, just "return false;"

[keertip, 2013/02/12 05:20:20]

Done.

+      }
+      
       var message = 'Looks great! Are you ready to upload your package';
 
       if (!warnings.isEmpty) {
         var s = warnings.length == 1 ? '' : 's';
         message = "Package has ${warnings.length} warning$s. Upload anyway";
       }
 
       return confirm(message).then((confirmed) {
         if (!confirmed) throw "Package upload canceled.";

[Bob Nystrom, 2013/02/12 01:00:41]

Instead of throwing here, do log.message() then return false.

[keertip, 2013/02/12 05:20:20]

Done.

+        return new Future.immediate(true);

[Bob Nystrom, 2013/02/12 01:00:41]

Just "return true".

[keertip, 2013/02/12 05:20:20]

Done.

       });
     });
   }
 }