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

utils/apidoc/apidoc.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.
 
 /**
  * This generates the reference documentation for the core libraries that come
  * with dart. It is built on top of dartdoc, which is a general-purpose library
  * for generating docs from any Dart code. This library extends that to include
  * additional information and styling specific to our standard library.
  *
@@ skipping 21 matching lines @@
 HtmlDiff _diff;
 
 void main() {
   final args = new Options().arguments;
 
   int mode = MODE_STATIC;
   Path outputDir = new Path('docs');
   bool generateAppCache = false;
 
   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;
 
   // Parse the command-line arguments.
   for (int i = 0; i < args.length; i++) {
     final arg = args[i];
 
     switch (arg) {
       case '--mode=static':
         mode = MODE_STATIC;
         break;
 
       case '--mode=live-nav':
         mode = MODE_LIVE_NAV;
         break;
 
       case '--generate-app-cache=true':
         generateAppCache = true;
         break;
 
       default:
         if (arg.startsWith('--exclude-lib=')) {
           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=')) {
           packageRoot = arg.substring('--package-root='.length);
         } else if (arg.startsWith('--version=')) {
           version = arg.substring('--version='.length);
         } else {
           print('Unknown option: $arg');
           return;
         }
@@ skipping 55 matching lines @@
       }
 
       if (new File.fromPath(libPath).existsSync()) {
         apidocLibraries.add(_pathToFileUri(libPath.toNativePath()));
         includedLibraries.add(libName);
       } else {
         print('Warning: could not find package at $path');
       }
     }
   }, 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 =
         scriptDir.append('../../sdk/lib/_internal/dartdoc/');
     // Select the libraries to include in the produced documentation:
     apidoc.includeApi = true;
     apidoc.includedLibraries = includedLibraries;
 
     // TODO(amouravski): make apidoc use roughly the same flow as bin/dartdoc.
     Future.wait([copiedStatic, copiedApiDocStatic, htmlDiff])
@@ skipping 303 matching lines @@
 /** Converts a local path string to a `file:` [Uri]. */
 Uri _pathToFileUri(String path) {
   path = pathos.absolute(path);
   if (Platform.operatingSystem != 'windows') {
     return Uri.parse('file://$path');
   } else {
     return Uri.parse('file:///${path.replaceAll("\\", "/")}');
   }
 }