support multiple headers

Author: devoncarew

bin/dartdoc.dart

@@ -74,15 +74,21 @@ main(List<String> arguments) async {
       args['include'] == null ? [] : args['include'].split(',');
 
   String url = args['hosted-url'];
-  String footerFilePath = _resolveTildePath(args['footer']);
-  if (footerFilePath != null && !new File(footerFilePath).existsSync()) {
-    print("Error: unable to locate the file with footer at ${footerFilePath}.");
-    exit(1);
+  List<String> footerFilePaths = args['footer'].map(_resolveTildePath).toList();
+  print(footerFilePaths);
+  for (String footerFilePath in footerFilePaths) {
+    if (!new File(footerFilePath).existsSync()) {
+      print("Error: unable to locate footer file: ${footerFilePath}.");
+      exit(1);
+    }
   }
-  String headerFilePath = _resolveTildePath(args['header']);
-  if (headerFilePath != null && !new File(headerFilePath).existsSync()) {
-    print("Error: unable to locate the file with header at ${headerFilePath}.");
-    exit(1);
+  List<String> headerFilePaths = args['header'].map(_resolveTildePath).toList();
+  print(headerFilePaths);
+  for (String headerFilePath in footerFilePaths) {
+    if (!new File(headerFilePath).existsSync()) {
+      print("Error: unable to locate header file: ${headerFilePath}.");
+      exit(1);
+    }
   }
 
   Directory outputDir =
@@ -112,7 +118,7 @@ main(List<String> arguments) async {
   print('');
 
   var generators = await initGenerators(
-      url, headerFilePath, footerFilePath, args['rel-canonical-prefix']);
+      url, headerFilePaths, footerFilePaths, args['rel-canonical-prefix']);
 
   for (var generator in generators) {
     generator.onFileCreated.listen(_onProgress);
@@ -163,7 +169,7 @@ ArgParser _createArgsParser() {
   parser.addFlag('version',
       help: 'Display the version for $name.', negatable: false);
   parser.addFlag('add-crossdart',
-      help: 'Add Crossdart links to the source code pieces',
+      help: 'Add Crossdart links to the source code pieces.',
       negatable: false,
       defaultsTo: false);
   parser.addOption('dart-sdk',
@@ -181,11 +187,11 @@ ArgParser _createArgsParser() {
   parser.addOption('output',
       help: 'Path to output directory.', defaultsTo: defaultOutDir);
   parser.addOption('header',
-      help:
-          'path to file containing HTML text, inserted into the header of every page.');
+      allowMultiple: true,
+      help: 'path to file containing HTML text.');
   parser.addOption('footer',
-      help:
-          'path to file containing HTML text, inserted into the footer of every page.');
+      allowMultiple: true,
+      help: 'path to file containing HTML text.');
   parser.addOption('exclude',
       help: 'Comma-separated list of library names to ignore.');
   parser.addOption('include',
@@ -194,9 +200,9 @@ ArgParser _createArgsParser() {
       help:
           'URL where the docs will be hosted (used to generate the sitemap).');
   parser.addOption('rel-canonical-prefix',
-      help: 'If provided, add a rel="canonical" prefixed with provided value. '
+      help: 'If provided, add a rel="canonical" prefixed with provided value. \n'
           'Consider using if building many versions of the docs for public SEO. '
-          'Learn more at https://goo.gl/gktN6F');
+          'Learn more at https://goo.gl/gktN6F.');
   parser.addFlag('include-source',
       help: 'If source code blocks should be shown, if they exist.',
       negatable: true,

lib/dartdoc.dart

@@ -44,13 +44,13 @@ const String version = '0.9.2';
 final String defaultOutDir = p.join('doc', 'api');
 
 /// Initialize and setup the generators.
-Future<List<Generator>> initGenerators(String url, String headerFilePath,
-    String footerFilePath, String relCanonicalPrefix) async {
+Future<List<Generator>> initGenerators(String url, List<String> headerFilePaths,
+    List<String> footerFilePaths, String relCanonicalPrefix) async {
   return [
     await HtmlGenerator.create(
         url: url,
-        header: headerFilePath,
-        footer: footerFilePath,
+        headers: headerFilePaths,
+        footers: footerFilePaths,
         relCanonicalPrefix: relCanonicalPrefix,
         toolVersion: version)
   ];

lib/src/html/html_generator.dart

@@ -48,12 +48,12 @@ class HtmlGenerator extends Generator {
   /// [url] - optional URL for where the docs will be hosted.
   static Future<HtmlGenerator> create(
       {String url,
-      String header,
-      String footer,
+      List<String> headers,
+      List<String> footers,
       String relCanonicalPrefix,
       String toolVersion}) async {
     var templates =
-        await Templates.create(headerPath: header, footerPath: footer);
+        await Templates.create(headerPaths: headers, footerPaths: footers);
 
     if (toolVersion == null) {
       toolVersion = 'unknown';

lib/src/html/templates.dart

@@ -32,22 +32,25 @@ const _partials = const <String>[
 ];
 
 Future<Map<String, String>> _loadPartials(
-    String headerPath, String footerPath) async {
+    List<String> headerPaths, List<String> footerPaths) async {
+  headerPaths ??= [];
+  footerPaths ??= [];
+
   var partials = <String, String>{};
 
   Future<String> _loadPartial(String templatePath) async {
     String template = await _getTemplateFile(templatePath);
-    // TODO: revisit, not sure this is the right place for this logic
-    if (templatePath.contains('_footer') && footerPath != null) {
-      String footerValue = await new File(footerPath).readAsString();
+    if (templatePath.contains('_head') && headerPaths.isNotEmpty) {
+      String headerValue = headerPaths.map((path) => new File(path).readAsStringSync()).join('\n');
       template =
-          template.replaceAll('<!-- Footer Placeholder -->', footerValue);
+          template.replaceAll('<!-- Header Placeholder -->', headerValue);
     }
-    if (templatePath.contains('_head') && headerPath != null) {
-      String headerValue = await new File(headerPath).readAsString();
+    if (templatePath.contains('_footer') && footerPaths.isNotEmpty) {
+      String footerValue = footerPaths.map((path) => new File(path).readAsStringSync()).join('\n');
       template =
-          template.replaceAll('<!-- Header Placeholder -->', headerValue);
+          template.replaceAll('<!-- Footer Placeholder -->', footerValue);
     }
+    template = template.replaceAll('  <!-- Do not remove placeholder -->\n', '');
     return template;
   }
 
@@ -75,8 +78,8 @@ class Templates {
   final TemplateRenderer typeDefTemplate;
 
   static Future<Templates> create(
-      {String headerPath, String footerPath}) async {
-    var partials = await _loadPartials(headerPath, footerPath);
+      {List<String> headerPaths, List<String> footerPaths}) async {
+    var partials = await _loadPartials(headerPaths, footerPaths);
 
     String _partial(String name) {
       String partial = partials[name];