Add a new --extra-lib option to apidoc that allows us to specify an explicit .dart file that should…

utils/apidoc/apidoc.dart

Index: utils/apidoc/apidoc.dart
===================================================================
--- utils/apidoc/apidoc.dart	(revision 22469)
+++ utils/apidoc/apidoc.dart	(working copy)
@@ -40,6 +40,7 @@
 
   List<String> excludedLibraries = <String>[];
   List<String> includedLibraries = <String>[];

[Andrei Mouravski, 2013/05/08 10:43:47]

You need to be more clear about this. Why is includedLibraries not good enough
for your use case?

[gram, 2013/05/08 22:14:36]

I added some comments in the code, but the long story is below:

The extra libraries are put in includedLibraries eventually, but there is
different logic being used for these, which is why, despite the gyp file
currently having --include-lib=mock.dart, it wasn't working before. We need some
collection to gather the arguments passed by --extra-lib unless we want to
process each one in place, which is not how any of the other similar flags are
being processed. Each of --include-lib and --exclude-lib have a collection to
gather these during argument processing, and I am being consistent with that
model.

include-lib currently only works for dart files whose names match the package
name - so unittest/lib/unittest.dart will work, but unittest/lib/matcher.dart
will not (similarly for mock.dart, vm_configuration.dart, etc etc). Because the
include-lib files are specified just with a filename <foo>.dart and then a check
is done for pkg/<foo>lib/<foo>.dart, we can't handle any other case in the
existing code. 

That leaves several options:

- leave the flag as is and add some processing where we search pkg recursively
for all files matching pkg/*/lib/<foo>.dart and add these; I don't like this as
it can violate the principle of least surprise
- change --include-lib to expect a full path in pkg like
--include-lib=unittest/lib/unittest.dart; I'm okay with that as an alternative
- change include-lib to handle either case, so we can do
--include-lib=unittest.dart --include-lib=unittest/lib/mock.dart; that's just
ugly
- leave --include-lib processing as it is, and add a different flag to handle
the <foo>/lib/<bar>.dart case, which to me is the cleanest and best solution and
the approach I took.

+  List<String> extraLibraries = <String>[]; // Libs with explicit paths.
   String packageRoot;
   String version;
 
@@ -65,6 +66,8 @@
           excludedLibraries.add(arg.substring('--exclude-lib='.length));
         } else if (arg.startsWith('--include-lib=')) {
           includedLibraries.add(arg.substring('--include-lib='.length));
+        } else if (arg.startsWith('--extra-lib=')) {
+          extraLibraries.add(arg.substring('--extra-lib='.length));
         } else if (arg.startsWith('--out=')) {
           outputDir = new Path(arg.substring('--out='.length));
         } else if (arg.startsWith('--package-root=')) {
@@ -140,6 +143,16 @@
       }
     }
   }, onDone: () {
+    // Add any --extra libraries that had full pkg paths.

[Andrei Mouravski, 2013/05/08 10:43:47]

This feels really hacky, so please add a TODO here to unhackify this.

[gram, 2013/05/08 22:14:36]

Done.

+    for (var lib in extraLibraries) {
+      var libPath = new Path('../../$lib');
+      if (new File.fromPath(libPath).existsSync()) {
+        apidocLibraries.add(_pathToFileUri(libPath.toNativePath()));
+        var libName = libPath.filename.replaceAll('.dart', '');
+        includedLibraries.add(libName);
+      }
+    }
+
     final apidoc = new Apidoc(mdn, outputDir, mode, generateAppCache,
                               excludedLibraries, version);
     apidoc.dartdocPath =