Add a setting to redirect debug logs to stderr instead of stdout.

microsoft · Mar 20, 2018 · c980c6b · c980c6b
1 parent 317a4ba
commit c980c6b
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 4 deletions.
diff --git a/app/exec/extension/_lib/vsix-manifest-builder.ts b/app/exec/extension/_lib/vsix-manifest-builder.ts
@@ -378,6 +378,7 @@ export class VsixManifestBuilder extends ManifestBuilder {
                     throw "Value for gitHubFlavoredMarkdown is invalid. Only boolean values are allowed.";
                 }
                 this.addProperty("Microsoft.VisualStudio.Services.GitHubFlavoredMarkdown", value.toString());
+                break;
             case "public":
                 if (typeof value === "boolean") {
                     let flags = _.get(this.data, "PackageManifest.Metadata[0].GalleryFlags[0]", "").split(" ");

diff --git a/app/lib/tfcommand.ts b/app/lib/tfcommand.ts
@@ -36,6 +36,7 @@ export interface CoreArguments {
     help: args.BooleanArgument;
     noPrompt: args.BooleanArgument;
     noColor: args.BooleanArgument;
+    debugLogStream: args.StringArgument;
 }
 
 export interface Executor<TResult> {
@@ -317,6 +318,13 @@ export abstract class TfCommand<TArguments extends CoreArguments, TResult> {
             args.BooleanArgument,
             "false",
         );
+        this.registerCommandArgument(
+            "debugLogStream",
+            "Debug message logging stream (stdout | stderr)",
+            "Stream used for writing debug logs (stdout or stderr)",
+            args.StringArgument,
+            "stdout",
+        );
     }
 
     /**
@@ -537,7 +545,7 @@ export abstract class TfCommand<TArguments extends CoreArguments, TResult> {
                     }
 
                     result += eol + cyan("Global arguments:") + eol;
-                    ["help", "save", "noColor", "noPrompt", "output", "json", "traceLevel"].forEach(arg => {
+                    ["help", "save", "noColor", "noPrompt", "output", "json", "traceLevel", "debugLogStream"].forEach(arg => {
                         result += singleArgData(arg, 9);
                     });
 
@@ -603,10 +611,21 @@ export abstract class TfCommand<TArguments extends CoreArguments, TResult> {
             })
             .then(() => {
                 return version.getTfxVersion().then(async semVer => {
-                    const [outputType, traceLevel] = await Promise.all([
+                    const [outputType, traceLevel, debugLogStream] = await Promise.all([
                         this.commandArgs.output.val(),
                         this.commandArgs.traceLevel.val(),
+                        this.commandArgs.debugLogStream.val(),
                     ]);
+                    switch (debugLogStream) {
+                        case "stdout":
+                            trace.debugLogStream = console.log;
+                            break;
+                        case "stderr":
+                            trace.debugLogStream = console.error;
+                            break;
+                        default:
+                            throw new Error("Parameter --debug-log-stream must have value 'stdout' or 'stderr'.");
+                    }
                     switch (traceLevel && traceLevel.toLowerCase()) {
                         case "none":
                             trace.traceLevel = trace.TraceLevel.None;

diff --git a/app/lib/trace.ts b/app/lib/trace.ts
@@ -9,6 +9,7 @@ export const enum TraceLevel {
 }
 
 export let traceLevel: TraceLevel = debugTracingEnvVar ? TraceLevel.Debug : TraceLevel.Info;
+export let debugLogStream = console.log;
 
 export type printable = string | number | boolean;
 
@@ -37,14 +38,14 @@ export function warn(msg: any, ...replacements: printable[]): void {
 export function debugArea(msg: any, area: string) {
     debugTracingEnvVar = process.env["TFX_TRACE_" + area.toUpperCase()];
     if (debugTracingEnvVar) {
-        log(colors.cyan(new Date().toISOString() + " : "), msg, colors.grey, []);
+        log(colors.cyan(new Date().toISOString() + " : "), msg, colors.grey, [], debugLogStream);
     }
     debugTracingEnvVar = process.env["TFX_TRACE"];
 }
 
 export function debug(msg: any, ...replacements: printable[]) {
     if (traceLevel >= TraceLevel.Debug) {
-        log(colors.cyan(new Date().toISOString() + " : "), msg, colors.grey, replacements);
+        log(colors.cyan(new Date().toISOString() + " : "), msg, colors.grey, replacements, debugLogStream);
     }
 }
 

diff --git a/tsconfig.json b/tsconfig.json
@@ -6,6 +6,7 @@
 		"declaration": false,
 		"sourceMap": true,
 		"newLine": "LF",
+		"noFallthroughCasesInSwitch": true,
 
 		// Note: dom is specified below so that the JSZip d.ts can use the Blob type.
 		"lib": ["es5", "es2015", "es6", "dom"],