pkg/docgen: add --indent-json option

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';
@@ skipping 41 matching lines @@
 /// Docgen constructor initializes the link resolver for markdown parsing.
 /// Also initializes the command line arguments.
 ///
 /// [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, String introFileName: '', out:
-    DEFAULT_OUTPUT_DIRECTORY, List<String> excludeLibraries: const [], bool
-    includeDependentPackages: false, String startPage, String dartBinary, String
-    pubScript}) {
+Future<bool> generateDocumentation(List<String> files, {String packageRoot,
+    bool outputToYaml: true, bool includePrivate: false, bool includeSdk: false,
+    bool parseSdk: false, String introFileName: '',
+    out: DEFAULT_OUTPUT_DIRECTORY, List<String> excludeLibraries: const [], bool
+    includeDependentPackages: false, String startPage, String dartBinary,
+    String pubScript, bool indentJSON: false}) {
   _excluded = excludeLibraries;
   _pubScript = pubScript;
   _dartBinary = dartBinary;
 
   logger.onRecord.listen((record) => print(record.message));
 
   _ensureOutputDirectory(out);
   var updatedPackageRoot = _obtainPackageRoot(packageRoot, parseSdk, files);
 
   var requestedLibraries = _findLibrariesToDocument(files,
@@ skipping 18 matching lines @@
         new Map.fromIterables(availableLibraries.map((each) => each.uri),
             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,
-        parseSdk: parseSdk, introFileName: introFileName, startPage: startPage);
+    _documentLibraries(librariesToDocument, includeSdk, parseSdk, introFileName,
+        startPage, indentJSON);
     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) {
   if (text == null) return;
-  Directory dir = new Directory(_outputDirectory);

[kevmoo, 2014/04/14 21:37:49]

This was a whole mountain of silly.

[Emily Fortuna, 2014/04/14 23:40:33]

oy vey. thank you.

-  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: FileMode.WRITE);
+
+  var filePath = path.join(_outputDirectory, filename);
+
+  var parentDir = new Directory(path.dirname(filePath));
+  if (!parentDir.existsSync()) parentDir.createSync(recursive: true);
+
+  new File(filePath)
+      .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 parseSdk: false, String introFileName: '', String startPage}) {
+void _documentLibraries(List<LibraryMirror> libs, bool includeSdk,
+  bool parseSdk, String introFileName, String startPage, bool indentJson) {
   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 = {
       'libraries': filteredEntities.where((e) => e is Library).map((e) =>
           e.previewMap).toList(),
       'introduction': _readIntroductionFile(introFileName, includeSdk),
       'filetype': 'json'
     };
-  _writeOutputFiles(libraryMap, filteredEntities, startPage);
+
+  var encoder = new JsonEncoder.withIndent(indentJson ? '  ' : null);
+
+  _writeOutputFiles(libraryMap, filteredEntities, startPage, encoder);
 }
 
 /// Output all of the libraries and classes into json files for consumption by a
 /// viewer.
 void _writeOutputFiles(Map<String, dynamic> libraryMap, Iterable<Indexable>
-    filteredEntities, String startPage) {
+    filteredEntities, String startPage, JsonEncoder encoder) {
   if (startPage != null) libraryMap['start-page'] = startPage;
 
-  _writeToFile(JSON.encode(libraryMap), 'library_list.json');
+  _writeToFile(encoder.convert(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);
+    _writeIndexableToFile(output, encoder);
   });
 
   // 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();
+  var sortedEntities = filteredEntities
+      .map((e) => '${e.qualifiedName} ${e.typeName}')
+      .toList();
 
-  _writeToFile(sortedEntities.join('\n') + '\n', 'index.txt');
+  sortedEntities.sort();
+
+  var buffer = new StringBuffer()

[kevmoo, 2014/04/14 21:37:49]

Avoid creating a huge string, then another one just to add the new line char at
the end

[Emily Fortuna, 2014/04/14 23:40:33]

sgtm

+    ..writeAll(sortedEntities, '\n')
+    ..write('\n');
+
+  _writeToFile(buffer.toString(), 'index.txt');
+
   var index = new SplayTreeMap.fromIterable(filteredEntities,
       key: (e) => e.qualifiedName, value: (e) => e.typeName);
 
-  _writeToFile(JSON.encode(index), 'index.json');
+  _writeToFile(encoder.convert(index), 'index.json');
 }
 
 /// Helper method to serialize the given Indexable out to a file.
-void _writeIndexableToFile(Indexable result) {
+void _writeIndexableToFile(Indexable result, JsonEncoder encoder) {
   var outputFile = result.fileName + '.json';
-  var output = JSON.encode(result.toMap());
+  var output = encoder.convert(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) {
   _outputDirectory = outputDirectory;
   var dir = new Directory(_outputDirectory);
   if (dir.existsSync()) dir.deleteSync(recursive: true);
 }
@@ skipping 201 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).
 """;