Improve formatting of diagnostic blocks

octogonz · octogonz · commit 10aec7b768fe · 2019-07-05T19:46:22.000-07:00
diff --git a/apps/api-extractor/src/api/Extractor.ts b/apps/api-extractor/src/api/Extractor.ts
@@ -194,17 +194,14 @@ export class Extractor {
     });
 
     if (messageRouter.showDiagnostics) {
-      messageRouter.logVerbose(ConsoleMessageId.Diagnostics, MessageRouter.DIAGNOSTICS_HEADER);
+      messageRouter.logDiagnosticHeader('Final prepared ExtractorConfig');
+      messageRouter.logDiagnostic(extractorConfig.getDiagnosticDump());
+      messageRouter.logDiagnosticFooter();
 
-      messageRouter.logVerbose(ConsoleMessageId.Diagnostics, 'Final prepared ExtractorConfig:');
-      messageRouter.logVerbose(ConsoleMessageId.Diagnostics, extractorConfig.getDiagnosticDump());
-
-      messageRouter.logVerbose(ConsoleMessageId.Diagnostics, '\nCompiler options:');
+      messageRouter.logDiagnosticHeader('Compiler options');
       const serializedOptions: object = MessageRouter.buildJsonDumpObject(compilerState.program.getCompilerOptions());
-      messageRouter.logVerbose(ConsoleMessageId.Diagnostics,
-        JSON.stringify(serializedOptions, undefined, 2));
-
-      messageRouter.logVerbose(ConsoleMessageId.Diagnostics, MessageRouter.DIAGNOSTICS_FOOTER);
+      messageRouter.logDiagnostic(JSON.stringify(serializedOptions, undefined, 2));
+      messageRouter.logDiagnosticFooter();
     }
 
     const collector: Collector = new Collector({
diff --git a/apps/api-extractor/src/collector/Collector.ts b/apps/api-extractor/src/collector/Collector.ts
@@ -29,7 +29,6 @@ import { TypeScriptInternals } from '../analyzer/TypeScriptInternals';
 import { MessageRouter } from './MessageRouter';
 import { AstReferenceResolver } from '../analyzer/AstReferenceResolver';
 import { ExtractorConfig } from '../api/ExtractorConfig';
-import { ConsoleMessageId } from '../api/ConsoleMessageId';
 
 /**
  * Options for Collector constructor.
@@ -169,19 +168,17 @@ export class Collector {
     }
 
     if (this.messageRouter.showDiagnostics) {
-
-      this.messageRouter.logVerbose(ConsoleMessageId.Diagnostics,
-        MessageRouter.DIAGNOSTICS_HEADER + '\nThe compiler analyzed these files:');
-      for (const sourceFile of this.program.getSourceFiles()) {
-        this.messageRouter.logVerbose(ConsoleMessageId.Diagnostics, sourceFile.fileName);
-      }
-
-      this.messageRouter.logVerbose(ConsoleMessageId.Diagnostics, '\nRoot filenames:');
+      this.messageRouter.logDiagnosticHeader('Root filenames');
       for (const fileName of this.program.getRootFileNames()) {
-        this.messageRouter.logVerbose(ConsoleMessageId.Diagnostics, fileName);
+        this.messageRouter.logDiagnostic(fileName);
       }
+      this.messageRouter.logDiagnosticFooter();
 
-      this.messageRouter.logVerbose(ConsoleMessageId.Diagnostics, MessageRouter.DIAGNOSTICS_FOOTER);
+      this.messageRouter.logDiagnosticHeader('Files analyzed by compiler');
+      for (const sourceFile of this.program.getSourceFiles()) {
+        this.messageRouter.logDiagnostic(sourceFile.fileName);
+      }
+      this.messageRouter.logDiagnosticFooter();
     }
 
     // Build the entry point
diff --git a/apps/api-extractor/src/collector/MessageRouter.ts b/apps/api-extractor/src/collector/MessageRouter.ts
@@ -39,8 +39,7 @@ export interface IMessageRouterOptions {
 }
 
 export class MessageRouter {
-  public static readonly DIAGNOSTICS_HEADER: string = '==[DIAGNOSTICS]===================================';
-  public static readonly DIAGNOSTICS_FOOTER: string = '==================================================\n';
+  public static readonly DIAGNOSTICS_LINE: string = '============================================================';
 
   private readonly _workingPackageFolder: string | undefined;
   private readonly _messageCallback: ((message: ExtractorMessage) => void) | undefined;
@@ -453,6 +452,20 @@ export class MessageRouter {
     }));
   }
 
+  public logDiagnosticHeader(title: string): void {
+    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE);
+    this.logDiagnostic(`DIAGNOSTIC: ` + title);
+    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE);
+  }
+
+  public logDiagnosticFooter(): void {
+    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE + '\n');
+  }
+
+  public logDiagnostic(message: string): void {
+    this.logVerbose(ConsoleMessageId.Diagnostics, message);
+  }
+
   /**
    * Give the calling application a chance to handle the `ExtractorMessage`, and if not, display it on the console.
    */
