dartdoc: --omit-generation-time flag to exclude generation time from output

lib/dartdoc/dartdoc.dart

 // Copyright (c) 2012, 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.
 
 /**
  * To generate docs for a library, run this script with the path to an
  * entrypoint .dart file, like:
  *
  *     $ dart dartdoc.dart foo.dart
  *
@@ skipping 37 matching lines @@
  */
 final MODE_LIVE_NAV = 1;
 
 /**
  * Run this from the `lib/dartdoc` directory.
  */
 void main() {
   final args = new Options().arguments;
 
   // Parse the dartdoc options.
   bool includeSource;

[Jennifer Messerly, 2012/06/04 17:47:01]

This comment is on the original code, but bools should initialized to false and
then they don't need to be tested as != null.

(That said, it's nice that you were consistent with the existing style :) )

[kevmoo-old, 2012/06/04 17:51:40]

Oh I thought about that...but I kept w/ the existing style.

   int mode;
   String outputDir;
   bool generateAppCache;
+  bool omitGenerationTime;

[Jennifer Messerly, 2012/06/04 17:47:01]

I almost wonder if this should be showGenerationTime and default to off. It
seems like this could be a feature of apidoc if we only want it for
api.dartlang.org

[kevmoo-old, 2012/06/04 17:51:40]

Easy to change this to a positive value, that defaults to true.

The fact that my code checks for a double-negative (!omits) bothered me.

 
   for (int i = 0; i < args.length - 1; i++) {
     final arg = args[i];
 
     switch (arg) {
       case '--no-code':
         includeSource = false;
         break;
 
       case '--mode=static':
         mode = MODE_STATIC;
         break;
 
       case '--mode=live-nav':
         mode = MODE_LIVE_NAV;
         break;
 
       case '--generate-app-cache':
       case '--generate-app-cache=true':
         generateAppCache = true;
         break;
 
+      case '--omit-generation-time':
+        omitGenerationTime = true;
+        break;
+
       default:
         if (arg.startsWith('--out=')) {
           outputDir = arg.substring('--out='.length);
         } else {
           print('Unknown option: $arg');
           return;
         }
         break;
     }
   }
@@ skipping 12 matching lines @@
 
   parseOptions(frogPath, ['', '', '--libdir=$libDir'], files);
   initializeWorld(files);
 
   final dartdoc = new Dartdoc();
 
   if (includeSource != null) dartdoc.includeSource = includeSource;
   if (mode != null) dartdoc.mode = mode;
   if (outputDir != null) dartdoc.outputDir = outputDir;
   if (generateAppCache != null) dartdoc.generateAppCache = generateAppCache;
+  if (omitGenerationTime != null) dartdoc.omitGenerationTime = omitGenerationTime;

[Jennifer Messerly, 2012/06/04 17:47:01]

We generally try to keep code at 80 cols. I'm not a huge fan of it personally,
but some people are pretty attached to it so we try to keep to that style in the
codebase.

[kevmoo-old, 2012/06/04 17:51:40]

Understood. Will fix.

 
   cleanOutputDirectory(dartdoc.outputDir);
 
   // Compile the client-side code to JS.
   final clientScript = (dartdoc.mode == MODE_STATIC) ? 'static' : 'live-nav';
   final Future scriptCompiled = compileScript(compilerPath,
                 '$scriptDir/client-$clientScript.dart',
                 '${dartdoc.outputDir}/client-$clientScript.js');
 
   final Future filesCopied = copyFiles('$scriptDir/static', dartdoc.outputDir);
@@ skipping 122 matching lines @@
   /**
    * The Google Custom Search ID that should be used for the search box. If
    * this is `null` then no search box will be shown.
    */
   String searchEngineId = null;
 
   /* The URL that the embedded search results should be displayed on. */
   String searchResultsUrl = 'results.html';
 
   /** Set this to add footer text to each generated page. */
-  String footerText = '';
+  String footerText = null;
 
   /** Set this to add content before the footer */
   String preFooterText = '';
 
+  /** Set this to omit generation timestamp from output */
+  bool omitGenerationTime = false;
+
   /**
    * From exposes the set of libraries in `world.libraries`. That maps library
    * *keys* to [Library] objects. The keys are *not* exactly the same as their
    * names. This means if we order by key, we won't actually have them sorted
    * correctly. This list contains the libraries in correct order by their
    * *name*.
    */
   List<Library> _sortedLibraries;
 
   CommentMap _comments;
@@ skipping 22 matching lines @@
     // Patch in support for [:...:]-style code to the markdown parser.
     // TODO(rnystrom): Markdown already has syntax for this. Phase this out?
     md.InlineParser.syntaxes.insertRange(0, 1,
         new md.CodeSyntax(@'\[\:((?:.|\n)*?)\:\]'));
 
     md.setImplicitLinkResolver((name) => resolveNameReference(name,
             library: _currentLibrary, type: _currentType,
             member: _currentMember));
   }
 
+  String get footerContent(){
+    var footerItems = [];
+    if(!omitGenerationTime) {
+      footerItems.add("This page generated at ${new Date.now()}");
+    }
+    if(footerText != null) {
+      footerItems.add(footerText);
+    }
+    var content = '';
+    for (int i = 0; i < footerItems.length; i++) {
+      if(i > 0){
+        content = content.concat('\n');
+      }
+      content = content.concat('<div>${footerItems[i]}</div>');
+    }
+    return content;
+  }
+
   void document([String entrypoint]) {
     var oldDietParse = options.dietParse;
     try {
       options.dietParse = true;
 
       // If we have an entrypoint, process it. Otherwise, just use whatever
       // libraries have been previously loaded by the calling code.
       if (entrypoint != null) {
         world.processDartScript(entrypoint);
       }
@@ skipping 140 matching lines @@
   }
 
   void writeFooter() {
     writeln(
         '''
         </div>
         <div class="clear"></div>
         </div>
         ${preFooterText}
         <div class="footer">
-          <p>This page generated at ${new Date.now()}</p>
-          <div>$footerText</div>
+          $footerContent
         </div>
         <script async src="${relativePath('$clientScript.js')}"></script>
         </body></html>
         ''');
   }
 
   void docIndex() {
     startFile('index.html');
 
     writeHeader(mainTitle, []);
@@ skipping 867 matching lines @@
       if (filename.endsWith('appcache.manifest')) {
         return;
       }
       var relativePath = filename.substring(pathPrefixLength + 1);
       write("$relativePath\n");
     };
     toCache.onDone = (done) => endFile();
     toCache.list(recursive: true);
   }
 }