Added pretty-index-json command line flag

Author: kevmoo

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 * fix multiple issues in annotation/feature list handling (#1268, #1162, #1081)
 
+* Added `pretty-index-json` command line flag.
+
 ## 0.9.12
 
 * add print styles

bin/dartdoc.dart

@@ -125,7 +125,9 @@ main(List<String> arguments) async {
 
   var generators = await initGenerators(
       url, headerFilePaths, footerFilePaths, args['rel-canonical-prefix'],
-      faviconPath: args['favicon'], useCategories: args['use-categories']);
+      faviconPath: args['favicon'],
+      useCategories: args['use-categories'],
+      prettyIndexJson: args['pretty-index-json']);
 
   for (var generator in generators) {
     generator.onFileCreated.listen(_onProgress);
@@ -222,6 +224,11 @@ ArgParser _createArgsParser() {
           'Include all the used libraries into the docs, even the ones not in the current package or "include-external"',
       negatable: false,
       defaultsTo: false);
+  parser.addFlag('pretty-index-json',
+      help:
+          "Generates `index.json` with indentation and newlines. The file is larger, but it's also easier to diff.",
+      negatable: false,
+      defaultsTo: false);
   return parser;
 }
 

lib/dartdoc.dart

@@ -47,7 +47,9 @@ final String defaultOutDir = path.join('doc', 'api');
 /// Initialize and setup the generators.
 Future<List<Generator>> initGenerators(String url, List<String> headerFilePaths,
     List<String> footerFilePaths, String relCanonicalPrefix,
-    {String faviconPath, bool useCategories: false}) async {
+    {String faviconPath,
+    bool useCategories: false,
+    bool prettyIndexJson: false}) async {
   return [
     await HtmlGenerator.create(
         url: url,
@@ -56,7 +58,8 @@ Future<List<Generator>> initGenerators(String url, List<String> headerFilePaths,
         relCanonicalPrefix: relCanonicalPrefix,
         toolVersion: version,
         faviconPath: faviconPath,
-        useCategories: useCategories)
+        useCategories: useCategories,
+        prettyIndexJson: prettyIndexJson)
   ];
 }
 

lib/src/html/html_generator.dart

@@ -41,6 +41,7 @@ class HtmlGenerator extends Generator {
   final String _toolVersion;
   final String faviconPath;
   final bool useCategories;
+  final bool prettyIndexJson;
 
   final StreamController<File> _onFileCreated =
       new StreamController(sync: true);
@@ -56,7 +57,8 @@ class HtmlGenerator extends Generator {
       String relCanonicalPrefix,
       String toolVersion,
       String faviconPath,
-      bool useCategories: false}) async {
+      bool useCategories: false,
+      bool prettyIndexJson: false}) async {
     var templates =
         await Templates.create(headerPaths: headers, footerPaths: footers);
 
@@ -65,18 +67,22 @@ class HtmlGenerator extends Generator {
     }
 
     return new HtmlGenerator._(url, relCanonicalPrefix, templates, toolVersion,
-        faviconPath: faviconPath, useCategories: useCategories);
+        faviconPath: faviconPath,
+        useCategories: useCategories,
+        prettyIndexJson: prettyIndexJson);
   }
 
   HtmlGenerator._(
       this._url, this._relCanonicalPrefix, this._templates, this._toolVersion,
-      {this.faviconPath, this.useCategories});
+      {this.faviconPath, this.useCategories, this.prettyIndexJson: false});
 
   @override
   Future generate(Package package, Directory out) {
     return new HtmlGeneratorInstance(_toolVersion, _url, _templates, package,
             out, _onFileCreated, _relCanonicalPrefix,
-            faviconPath: faviconPath, useCategories: useCategories)
+            faviconPath: faviconPath,
+            useCategories: useCategories,
+            prettyIndexJson: prettyIndexJson)
         .generate();
   }
 }

lib/src/html/html_generator_instance.dart

@@ -3,7 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:async' show Future, StreamController;
-import 'dart:convert' show JSON;
+import 'dart:convert' show JsonEncoder;
 import 'dart:io' show Directory, File, stdout;
 import 'dart:typed_data' show Uint8List;
 
@@ -28,10 +28,11 @@ class HtmlGeneratorInstance implements HtmlOptions {
   final String toolVersion;
   final String faviconPath;
   final bool useCategories;
+  final bool prettyIndexJson;
 
   HtmlGeneratorInstance(this.toolVersion, this.url, this._templates,
       this.package, this.out, this._onFileCreated, this.relCanonicalPrefix,
-      {this.faviconPath, this.useCategories});
+      {this.faviconPath, this.useCategories, this.prettyIndexJson: false});
 
   Future generate() async {
     if (!out.existsSync()) out.createSync();
@@ -50,7 +51,11 @@ class HtmlGeneratorInstance implements HtmlOptions {
 
   void _generateSearchIndex() {
     File jsonFile = _createOutputFile(out, 'index.json');
-    String json = JSON.encode(
+
+    var encoder =
+        prettyIndexJson ? new JsonEncoder.withIndent(' ') : new JsonEncoder();
+
+    String json = encoder.convert(
         documentedElements.where((e) => e.isCanonical).map((ModelElement e) {
       Map data = {
         'name': e.name,