Add a pub validator for compiled dartdoc output.

Add a pub validator for compiled dartdoc output.

BUG=7045
Committed: https://code.google.com/p/dart/source/detail?r=17943

[Bob Nystrom, 2013-01-31 18:54:54]

I worry that this will just annoy users for little benefit. But otherwise LGTM.

https://codereview.chromium.org/12089076/diff/1/utils/pub/utils.dart
File utils/pub/utils.dart (right):

https://codereview.chromium.org/12089076/diff/1/utils/pub/utils.dart#newcode131
utils/pub/utils.dart:131: }
It took me a surprisingly long while to tease apart how this works.

One small simplification would be to not allow mixed mode filtering: require
test() to always return Future<bool>. That would let you type it, and make the
code a bit simpler.

https://codereview.chromium.org/12089076/diff/1/utils/pub/validator/compiled_...
File utils/pub/validator/compiled_dartdoc.dart (right):

https://codereview.chromium.org/12089076/diff/1/utils/pub/validator/compiled_...
utils/pub/validator/compiled_dartdoc.dart:16: /// A validator that validates
that a package doesn't contain compiled Dartdoc
"A validator that validates" -> "Validates".

https://codereview.chromium.org/12089076/diff/1/utils/pub/validator/compiled_...
utils/pub/validator/compiled_dartdoc.dart:40: "$relativePath.\n"
How about:

Avoid putting generated documentation in doc/.
That directory is intended to contain hand-created documentation.
Generated documentation just bloats the package with redundant data.

[nweiz, 2013-01-31 20:31:54]

https://codereview.chromium.org/12089076/diff/1/utils/pub/utils.dart
File utils/pub/utils.dart (right):

https://codereview.chromium.org/12089076/diff/1/utils/pub/utils.dart#newcode131
utils/pub/utils.dart:131: }
On 2013/01/31 18:54:54, Bob Nystrom wrote:
> It took me a surprisingly long while to tease apart how this works.
> 
> One small simplification would be to not allow mixed mode filtering: require
> test() to always return Future<bool>. That would let you type it, and make the
> code a bit simpler.

Doing that makes the code using this worse. I think this is about as clear as it
can be, until Stream.where supports asynchronous return values.

https://codereview.chromium.org/12089076/diff/1/utils/pub/validator/compiled_...
File utils/pub/validator/compiled_dartdoc.dart (right):

https://codereview.chromium.org/12089076/diff/1/utils/pub/validator/compiled_...
utils/pub/validator/compiled_dartdoc.dart:16: /// A validator that validates
that a package doesn't contain compiled Dartdoc
On 2013/01/31 18:54:54, Bob Nystrom wrote:
> "A validator that validates" -> "Validates".

Done.

https://codereview.chromium.org/12089076/diff/1/utils/pub/validator/compiled_...
utils/pub/validator/compiled_dartdoc.dart:40: "$relativePath.\n"
On 2013/01/31 18:54:54, Bob Nystrom wrote:
> How about:
> 
> Avoid putting generated documentation in doc/.
> That directory is intended to contain hand-created documentation.
> Generated documentation just bloats the package with redundant data.

The "that directory" text only makes sense if they put it in "doc" specifically,
which they won't always do. I'll use the other lines, though.