pkg/docgen: removed yaml and append output support

pkg/docgen/lib/src/generator.dart

 // Copyright (c) 2014, 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 docgen.generator;
 
 import 'dart:async';
 import 'dart:collection';
 import 'dart:convert';
 import 'dart:io';
 
 import 'package:markdown/markdown.dart' as markdown;
 import 'package:path/path.dart' as path;
 
 import '../../../../sdk/lib/_internal/compiler/compiler.dart' as api;
 import '../../../../sdk/lib/_internal/compiler/implementation/filenames.dart';
 import '../../../../sdk/lib/_internal/compiler/implementation/mirrors/analyze.dart'
     as dart2js;
 import '../../../../sdk/lib/_internal/compiler/implementation/mirrors/dart2js_mirrors.dart'
     as dart2js_mirrors;
 import '../../../../sdk/lib/_internal/compiler/implementation/mirrors/mirrors_util.dart'
     as dart2js_util;
 import '../../../../sdk/lib/_internal/compiler/implementation/mirrors/source_mirrors.dart';
 import '../../../../sdk/lib/_internal/compiler/implementation/source_file_provider.dart';
 import '../../../../sdk/lib/_internal/libraries.dart';
 
-import 'dart2yaml.dart';
 import 'io.dart';
 import 'library_helpers.dart';
 import 'models.dart';
 import 'package_helpers.dart' show packageNameFor, rootDirectory;
 
 const String DEFAULT_OUTPUT_DIRECTORY = 'docs';
 
 /// The directory where the output docs are generated.
 String get outputDirectory => _outputDirectory;
 String _outputDirectory;
@@ skipping 17 matching lines @@
 ///
 /// [packageRoot] is the packages directory of the directory being analyzed.
 /// If [includeSdk] is `true`, then any SDK libraries explicitly imported will
 /// also be documented.
 /// If [parseSdk] is `true`, then all Dart SDK libraries will be documented.
 /// This option is useful when only the SDK libraries are needed.
 ///
 /// Returned Future completes with true if document generation is successful.
 Future<bool> generateDocumentation(List<String> files, {String packageRoot, bool
     outputToYaml: true, bool includePrivate: false, bool includeSdk: false, bool
-    parseSdk: false, bool append: false, String introFileName: '', out:
+    parseSdk: false, String introFileName: '', out:
     DEFAULT_OUTPUT_DIRECTORY, List<String> excludeLibraries: const [], bool
     includeDependentPackages: false, String startPage, String dartBinary, String
     pubScript}) {
   _excluded = excludeLibraries;
   _pubScript = pubScript;
   _dartBinary = dartBinary;
 
   logger.onRecord.listen((record) => print(record.message));
 
-  _ensureOutputDirectory(out, append);
+  _ensureOutputDirectory(out);
   var updatedPackageRoot = _obtainPackageRoot(packageRoot, parseSdk, files);
 
   var requestedLibraries = _findLibrariesToDocument(files,
       includeDependentPackages);
 
   var allLibraries = []..addAll(requestedLibraries);
   if (includeSdk) {
     allLibraries.addAll(_listSdk());
   }
 
@@ skipping 12 matching lines @@
             availableLibraries);
     var librariesToDocument = requestedLibraries
           .map((each) {
             return availableLibrariesByPath
                 .putIfAbsent(each, () => throw "Missing library $each");
     }).toList();
     librariesToDocument.addAll((includeSdk || parseSdk) ? sdkLibraries : []);
     librariesToDocument.removeWhere((x) => _excluded.contains(
         dart2js_util.nameOf(x)));
     _documentLibraries(librariesToDocument, includeSdk: includeSdk,
-        outputToYaml: outputToYaml, append: append, parseSdk: parseSdk,
-        introFileName: introFileName, startPage: startPage);
+        parseSdk: parseSdk, introFileName: introFileName, startPage: startPage);
     return true;
   });
 }
 
 
 /// Analyzes set of libraries by getting a mirror system and triggers the
 /// documentation of the libraries.
 Future<MirrorSystem> getMirrorSystem(List<Uri> libraries,
     bool includePrivate, {String packageRoot, bool parseSdk: false}) {
   if (libraries.isEmpty) throw new StateError('No Libraries.');
 
   includePrivateMembers = includePrivate;
 
   // Finds the root of SDK library based off the location of docgen.
   // We have two different places to look, depending if we're in a development
   // repo or in a built SDK, either sdk or dart-sdk respectively
   var root = rootDirectory;
   var sdkRoot = path.normalize(path.absolute(path.join(root, 'sdk')));
   if (!new Directory(sdkRoot).existsSync()) {
     sdkRoot = path.normalize(path.absolute(path.join(root, 'dart-sdk')));
   }
   logger.info('SDK Root: ${sdkRoot}');
   return analyzeLibraries(libraries, sdkRoot,
       packageRoot: packageRoot);
 }
 
 /// Writes [text] to a file in the output directory.
-void _writeToFile(String text, String filename, {bool append: false}) {
+void _writeToFile(String text, String filename) {
   if (text == null) return;
   Directory dir = new Directory(_outputDirectory);
   if (!dir.existsSync()) {
     dir.createSync();
   }
   if (path.split(filename).length > 1) {
     var splitList = path.split(filename);
     for (int i = 0; i < splitList.length; i++) {
       var level = splitList[i];
     }
     for (var level in path.split(filename)) {
       var subdir = new Directory(path.join(_outputDirectory, path.dirname(
           filename)));
       if (!subdir.existsSync()) {
         subdir.createSync();
       }
     }
   }
   File file = new File(path.join(_outputDirectory, filename));
-  file.writeAsStringSync(text, mode: append ? FileMode.APPEND : FileMode.WRITE);
+  file.writeAsStringSync(text, mode: FileMode.WRITE);
 }
 
 /// Resolve all the links in the introductory comments for a given library or
 /// package as specified by [filename].
 String _readIntroductionFile(String fileName, bool includeSdk) {
   var linkResolver = (name) => globalFixReference(name);
   var defaultText = includeSdk ? _DEFAULT_SDK_INTRODUCTION : '';
   var introText = defaultText;
   if (fileName.isNotEmpty) {
     var introFile = new File(fileName);
@@ skipping 13 matching lines @@
     return compare;
   }
 
   if (a is Library) return -1;
   if (b is Library) return 1;
 
   return a.qualifiedName.compareTo(b.qualifiedName);
 }
 
 /// Creates documentation for filtered libraries.
-void _documentLibraries(List<LibraryMirror> libs, {bool includeSdk: false, bool
-    outputToYaml: true, bool append: false, bool parseSdk: false, String
-    introFileName: '', String startPage}) {
+void _documentLibraries(List<LibraryMirror> libs, {bool includeSdk: false,
+  bool parseSdk: false, String introFileName: '', String startPage}) {
   libs.forEach((lib) {
     // Files belonging to the SDK have a uri that begins with 'dart:'.
     if (includeSdk || !lib.uri.toString().startsWith('dart:')) {
       generateLibrary(lib);
     }
   });
 
   var filteredEntities = new SplayTreeSet<Indexable>(_indexableComparer);
   for (Map<String, Set<Indexable>> firstLevel in mirrorToDocgen.values) {
     for (Set<Indexable> items in firstLevel.values) {
       for (Indexable item in items) {
         if (isFullChainVisible(item)) {
           if (item is! Method ||
               (item is Method && item.methodInheritedFrom == null)) {
             filteredEntities.add(item);
           }
         }
       }
     }
   }
 
   // Outputs a JSON file with all libraries and their preview comments.
   // This will help the viewer know what libraries are available to read in.
-  Map<String, dynamic> libraryMap;
-
-  if (append) {
-    var docsDir = listDir(_outputDirectory);
-    if (!docsDir.contains('$_outputDirectory/library_list.json')) {
-      throw new StateError('No library_list.json');
-    }
-    libraryMap = JSON.decode(new File('$_outputDirectory/library_list.json'
-        ).readAsStringSync());
-    libraryMap['libraries'].addAll(filteredEntities.where((e) => e is Library
-        ).map((e) => e.previewMap));
-    var intro = libraryMap['introduction'];
-    var spacing = intro.isEmpty ? '' : '<br/><br/>';
-    libraryMap['introduction'] =
-        "$intro$spacing${_readIntroductionFile(introFileName, includeSdk)}";
-    outputToYaml = libraryMap['filetype'] == 'yaml';
-  } else {
-    libraryMap = {
+  Map<String, dynamic> libraryMap = {
       'libraries': filteredEntities.where((e) => e is Library).map((e) =>
           e.previewMap).toList(),
       'introduction': _readIntroductionFile(introFileName, includeSdk),
-      'filetype': outputToYaml ? 'yaml' : 'json'
+      'filetype': 'json'
     };
-  }
-  _writeOutputFiles(libraryMap, filteredEntities, outputToYaml, append,
-      startPage);
+  _writeOutputFiles(libraryMap, filteredEntities, startPage);
 }
 
-/// Output all of the libraries and classes into json or yaml files for
-/// consumption by a viewer.
+/// Output all of the libraries and classes into json files for consumption by a
+/// viewer.
 void _writeOutputFiles(Map<String, dynamic> libraryMap, Iterable<Indexable>
-    filteredEntities, bool outputToYaml, bool append, String startPage) {
+    filteredEntities, String startPage) {
   if (startPage != null) libraryMap['start-page'] = startPage;
 
   _writeToFile(JSON.encode(libraryMap), 'library_list.json');
 
   // Output libraries and classes to file after all information is generated.
   filteredEntities.where((e) => e is Class || e is Library).forEach((output) {
-    _writeIndexableToFile(output, outputToYaml);
+    _writeIndexableToFile(output);
   });
 
   // Outputs all the qualified names documented with their type.
   // This will help generate search results.
   var sortedEntities = filteredEntities.map((e) =>
       '${e.qualifiedName} ${e.typeName}').toList()..sort();
 
-  _writeToFile(sortedEntities.join('\n') + '\n', 'index.txt', append: append);
+  _writeToFile(sortedEntities.join('\n') + '\n', 'index.txt');
   var index = new SplayTreeMap.fromIterable(filteredEntities,
       key: (e) => e.qualifiedName, value: (e) => e.typeName);
 
-  if (append) {
-    var previousIndex = JSON.decode(new File('$_outputDirectory/index.json'
-        ).readAsStringSync());
-    index.addAll(previousIndex);
-  }
   _writeToFile(JSON.encode(index), 'index.json');
 }
 
 /// Helper method to serialize the given Indexable out to a file.
-void _writeIndexableToFile(Indexable result, bool outputToYaml) {
-  var outputFile = result.fileName;
-  var output;
-  if (outputToYaml) {
-    output = getYamlString(result.toMap());
-    outputFile = outputFile + '.yaml';
-  } else {
-    output = JSON.encode(result.toMap());
-    outputFile = outputFile + '.json';
-  }
+void _writeIndexableToFile(Indexable result) {
+  var outputFile = result.fileName + '.json';
+  var output = JSON.encode(result.toMap());
   _writeToFile(output, outputFile);
 }
 
 /// Set the location of the ouput directory, and ensure that the location is
 /// available on the file system.
-void _ensureOutputDirectory(String outputDirectory, bool append) {
+void _ensureOutputDirectory(String outputDirectory) {
   _outputDirectory = outputDirectory;
-  if (!append) {
-    var dir = new Directory(_outputDirectory);
-    if (dir.existsSync()) dir.deleteSync(recursive: true);
-  }
+  var dir = new Directory(_outputDirectory);
+  if (dir.existsSync()) dir.deleteSync(recursive: true);
 }
 
 /// Analyzes set of libraries and provides a mirror system which can be used
 /// for static inspection of the source code.
 Future<MirrorSystem> analyzeLibraries(List<Uri> libraries, String
     libraryRoot, {String packageRoot}) {
   SourceFileProvider provider = new CompilerSourceFileProvider();
   api.DiagnosticHandler diagnosticHandler = (new FormattingDiagnosticHandler(
       provider)
       ..showHints = false
@@ skipping 12 matching lines @@
         // system, and it is not possible to use the stack trace. BUG(#11622)
         // To avoid printing the stack trace.
         exit(1);
       });
 }
 
 /// For this run of docgen, determine the packageRoot value.
 ///
 /// If packageRoot is not explicitly passed, we examine the files we're
 /// documenting to attempt to find a package root.
-String _obtainPackageRoot(String packageRoot, bool parseSdk, List<String> files)
-    {
+String _obtainPackageRoot(String packageRoot, bool parseSdk,
+    List<String> files) {
   if (packageRoot == null && !parseSdk) {
     var type = FileSystemEntity.typeSync(files.first);
     if (type == FileSystemEntityType.DIRECTORY) {
       var files2 = listDir(files.first, recursive: true);
       // Return '' means that there was no pubspec.yaml and therefor no p
       // ackageRoot.
       packageRoot = files2.firstWhere((f) => f.endsWith(
           '${path.separator}pubspec.yaml'), orElse: () => '');
       if (packageRoot != '') {
         packageRoot = path.join(path.dirname(packageRoot), 'packages');
@@ skipping 158 matching lines @@
   * [Samples](http://www.dartlang.org/samples/)
   * [A Tour of the Dart Libraries](http://www.dartlang.org/docs/dart-up-and-running/contents/ch03.html)
 
 This API reference is automatically generated from the source code in the
 [Dart project](https://code.google.com/p/dart/).
 If you'd like to contribute to this documentation, see
 [Contributing](https://code.google.com/p/dart/wiki/Contributing)
 and
 [Writing API Documentation](https://code.google.com/p/dart/wiki/WritingApiDocumentation).
 """;