Implement new combined dartdoc option class (#1666)

* Squash commits

* Windows drive letters :-(

* Forgot a slash

* Canonicalization missed one spot.

* One more capitalization problem

* Review comments

Author: jcollins-g

bin/dartdoc.dart

@@ -200,7 +200,7 @@ main(List<String> arguments) async {
     ]);
   }
 
-  DartDocConfig config = new DartDocConfig.fromParameters(
+  DartdocConfig config = new DartdocConfig.fromParameters(
     addCrossdart: args['add-crossdart'],
     autoIncludeDependencies: args['auto-include-dependencies'],
     dropTextFrom: dropTextFrom,
@@ -230,20 +230,20 @@ main(List<String> arguments) async {
     verboseWarnings: args['verbose-warnings'],
   );
 
-  DartDoc dartdoc =
-      await DartDoc.withDefaultGenerators(config, outputDir, packageMeta);
+  Dartdoc dartdoc =
+      await Dartdoc.withDefaultGenerators(config, outputDir, packageMeta);
 
   dartdoc.onCheckProgress.listen(logProgress);
   await Chain.capture(() async {
     await runZoned(() async {
-      DartDocResults results = await dartdoc.generateDocs();
+      DartdocResults results = await dartdoc.generateDocs();
       logInfo('Success! Docs generated into ${results.outDir.absolute.path}');
     },
         zoneSpecification: new ZoneSpecification(
             print: (Zone self, ZoneDelegate parent, Zone zone, String line) =>
                 logPrint(line)));
   }, onError: (e, Chain chain) {
-    if (e is DartDocFailure) {
+    if (e is DartdocFailure) {
       stderr.writeln('\nGeneration failed: ${e}.');
       exit(1);
     } else {

lib/dartdoc.dart

@@ -65,7 +65,7 @@ Future<List<Generator>> _initGenerators(String url, String relCanonicalPrefix,
 
 /// Generates Dart documentation for all public Dart libraries in the given
 /// directory.
-class DartDoc extends PackageBuilder {
+class Dartdoc extends PackageBuilder {
   final List<Generator> generators;
   final Directory outputDir;
   final Set<String> writtenFiles = new Set();
@@ -74,13 +74,13 @@ class DartDoc extends PackageBuilder {
   final StreamController<String> _onCheckProgress =
       new StreamController(sync: true);
 
-  DartDoc._(DartDocConfig config, this.generators, this.outputDir,
+  Dartdoc._(DartdocConfig config, this.generators, this.outputDir,
       PackageMeta packageMeta)
       : super(config, packageMeta);
 
   /// An asynchronous factory method that builds Dartdoc's file writers
-  /// and returns a DartDoc object with them.
-  static withDefaultGenerators(DartDocConfig config, Directory outputDir,
+  /// and returns a Dartdoc object with them.
+  static withDefaultGenerators(DartdocConfig config, Directory outputDir,
       PackageMeta packageMeta) async {
     var generators = await _initGenerators(
         config.hostedUrl, config.relCanonicalPrefix,
@@ -92,12 +92,12 @@ class DartDoc extends PackageBuilder {
     for (var generator in generators) {
       generator.onFileCreated.listen(logProgress);
     }
-    return new DartDoc._(config, generators, outputDir, packageMeta);
+    return new Dartdoc._(config, generators, outputDir, packageMeta);
   }
 
-  factory DartDoc.withoutGenerators(
-      DartDocConfig config, Directory outputDir, PackageMeta packageMeta) {
-    return new DartDoc._(config, [], outputDir, packageMeta);
+  factory Dartdoc.withoutGenerators(
+      DartdocConfig config, Directory outputDir, PackageMeta packageMeta) {
+    return new Dartdoc._(config, [], outputDir, packageMeta);
   }
 
   Stream<String> get onCheckProgress => _onCheckProgress.stream;
@@ -145,19 +145,19 @@ class DartDoc extends PackageBuilder {
 
     if (errors.isNotEmpty) {
       int len = errors.length;
-      throw new DartDocFailure(
+      throw new DartdocFailure(
           "encountered ${len} analysis error${len == 1 ? '' : 's'}");
     }
   }
 
   PackageGraph packageGraph;
 
-  /// Generate DartDoc documentation.
+  /// Generate Dartdoc documentation.
   ///
-  /// [DartDocResults] is returned if dartdoc succeeds. [DartDocFailure] is
+  /// [DartdocResults] is returned if dartdoc succeeds. [DartdocFailure] is
   /// thrown if dartdoc fails in an expected way, for example if there is an
   /// analysis error in the code.
-  Future<DartDocResults> generateDocs() async {
+  Future<DartdocResults> generateDocs() async {
     Stopwatch _stopwatch = new Stopwatch()..start();
     double seconds;
     packageGraph = await buildPackageGraph();
@@ -193,15 +193,15 @@ class DartDoc extends PackageBuilder {
         "in ${seconds.toStringAsFixed(1)} seconds");
 
     if (packageGraph.publicLibraries.isEmpty) {
-      throw new DartDocFailure(
+      throw new DartdocFailure(
           "dartdoc could not find any libraries to document. Run `pub get` and try again.");
     }
 
     if (packageGraph.packageWarningCounter.errorCount > 0) {
-      throw new DartDocFailure("dartdoc encountered errors while processing");
+      throw new DartdocFailure("dartdoc encountered errors while processing");
     }
 
-    return new DartDocResults(packageMeta, packageGraph, outputDir);
+    return new DartdocResults(packageMeta, packageGraph, outputDir);
   }
 
   /// Warn on file paths.
@@ -421,22 +421,22 @@ class DartDoc extends PackageBuilder {
 
 /// This class is returned if dartdoc fails in an expected way (for instance, if
 /// there is an analysis error in the library).
-class DartDocFailure {
+class DartdocFailure {
   final String message;
 
-  DartDocFailure(this.message);
+  DartdocFailure(this.message);
 
   @override
   String toString() => message;
 }
 
-/// The results of a [DartDoc.generateDocs] call.
-class DartDocResults {
+/// The results of a [Dartdoc.generateDocs] call.
+class DartdocResults {
   final PackageMeta packageMeta;
   final PackageGraph packageGraph;
   final Directory outDir;
 
-  DartDocResults(this.packageMeta, this.packageGraph, this.outDir);
+  DartdocResults(this.packageMeta, this.packageGraph, this.outDir);
 }
 
 class _Error implements Comparable<_Error> {

lib/src/config.dart

@@ -2,6 +2,7 @@
 // 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.
 
+/// Legacy dartdoc configuration library.  TODO(jcollins-g): merge with [DartdocOption].
 library dartdoc.config;
 
 import 'dart:io';
@@ -25,7 +26,7 @@ String _resolveTildePath(String originalPath) {
   return pathLib.join(homeDir, originalPath.substring(2));
 }
 
-class DartDocConfig {
+class DartdocConfig {
   final bool addCrossdart;
   final bool autoIncludeDependencies;
   final List<String> dropTextFrom;
@@ -50,7 +51,7 @@ class DartDocConfig {
   final bool showWarnings;
   final bool validateLinks;
   final bool verboseWarnings;
-  DartDocConfig._(
+  DartdocConfig._(
     this.addCrossdart,
     this.autoIncludeDependencies,
     this.dropTextFrom,
@@ -77,13 +78,13 @@ class DartDocConfig {
     this.verboseWarnings,
   ) {
     if (sdkDir == null || !sdkDir.existsSync()) {
-      throw new DartDocFailure("Error: unable to locate the Dart SDK.");
+      throw new DartdocFailure("Error: unable to locate the Dart SDK.");
     }
 
     footerFilePaths = footerFilePaths.map((p) => _resolveTildePath(p)).toList();
     for (String footerFilePath in footerFilePaths) {
       if (!new File(footerFilePath).existsSync()) {
-        throw new DartDocFailure(
+        throw new DartdocFailure(
             "fatal error: unable to locate footer file: ${footerFilePath}.");
       }
     }
@@ -92,21 +93,21 @@ class DartDocConfig {
         footerTextFilePaths.map((p) => _resolveTildePath(p)).toList();
     for (String footerTextFilePath in footerTextFilePaths) {
       if (!new File(footerTextFilePath).existsSync()) {
-        throw new DartDocFailure(
+        throw new DartdocFailure(
             "fatal error: unable to locate footer-text file: ${footerTextFilePath}.");
       }
     }
 
     headerFilePaths = headerFilePaths.map((p) => _resolveTildePath(p)).toList();
     for (String headerFilePath in headerFilePaths) {
       if (!new File(headerFilePath).existsSync()) {
-        throw new DartDocFailure(
+        throw new DartdocFailure(
             "fatal error: unable to locate header file: ${headerFilePath}.");
       }
     }
   }
 
-  factory DartDocConfig.fromParameters({
+  factory DartdocConfig.fromParameters({
     bool addCrossdart: false,
     bool autoIncludeDependencies: false,
     List<String> dropTextFrom,
@@ -132,7 +133,7 @@ class DartDocConfig {
     bool validateLinks: true,
     bool verboseWarnings: true,
   }) {
-    return new DartDocConfig._(
+    return new DartdocConfig._(
       addCrossdart,
       autoIncludeDependencies,
       dropTextFrom ?? const <String>[],