custom logger (using developer tools is messy)

DonJayamanne · DonJayamanne · commit ad22c751f94e · 2016-03-11T20:20:26.000+11:00
diff --git a/package.json b/package.json
@@ -216,6 +216,11 @@
           "default": "python",
           "description": "Path to Python, you can use a custom version of Python by modifying this setting to include the full path."
         },
+        "python.devOptions": {
+          "type": "array",
+          "default": [],
+          "description": "Advanced options used to enable new features or produce detailed diagnostics to identify extension issues."
+        },
         "python.linting.enabled": {
           "type": "boolean",
           "default": true,
diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts
@@ -6,6 +6,7 @@ import * as fs from 'fs';
 
 export interface IPythonSettings {
     pythonPath: string;
+    devOptions: any[];
     linting: ILintingSettings;
     formatting: IFormattingSettings;
     unitTest: IUnitTestSettings;
@@ -54,6 +55,8 @@ export class PythonSettings implements IPythonSettings {
     private initializeSettings() {
         var pythonSettings = vscode.workspace.getConfiguration("python");
         this.pythonPath = pythonSettings.get<string>("pythonPath");
+        this.devOptions = pythonSettings.get<any[]>("devOptions");
+        this.devOptions = Array.isArray(this.devOptions) ? this.devOptions : [];
         var lintingSettings = pythonSettings.get<ILintingSettings>("linting");
         if (this.linting) {
             Object.assign<ILintingSettings, ILintingSettings>(this.linting, lintingSettings);
@@ -88,6 +91,7 @@ export class PythonSettings implements IPythonSettings {
     }
 
     public pythonPath: string;
+    public devOptions: any[];
     public linting: ILintingSettings;
     public formatting: IFormattingSettings;
     public autoComplete: IAutoCompeteSettings;
diff --git a/src/client/common/logger.ts b/src/client/common/logger.ts
@@ -0,0 +1,40 @@
+import * as vscode from 'vscode';
+import * as settings from './configSettings'
+
+let outChannel: vscode.OutputChannel;
+let pythonSettings: settings.IPythonSettings;
+
+class Logger {
+    static initializeChannel() {
+        if (pythonSettings) return;
+        pythonSettings = new settings.PythonSettings();
+        if (pythonSettings.devOptions.indexOf("DEBUG") >= 0) {
+            outChannel = vscode.window.createOutputChannel('PythonExtLog');
+        }
+    }
+
+    static write(category: string = "log", title: string = "", message: any) {
+        Logger.initializeChannel();
+        if (title.length > 0) {
+            Logger.writeLine(category, "---------------------------");
+            Logger.writeLine(category, title);
+        }
+
+        Logger.writeLine(category, message);
+    }
+    static writeLine(category: string = "log", line: any) {
+        console[category](line);
+        if (outChannel) {
+            outChannel.appendLine(line);
+        }
+    }
+}
+export function error(title: string = "", message: any) {
+    Logger.write.apply(Logger, ["error", title, message]);
+}
+export function warn(title: string = "", message: any) {
+    Logger.write.apply(Logger, ["warn", title, message]);
+}
+export function log(title: string = "", message: any) {
+    Logger.write.apply(Logger, ["log", title, message]);
+}
diff --git a/src/client/extension.ts b/src/client/extension.ts
@@ -44,11 +44,7 @@ export function activate(context: vscode.ExtensionContext) {
 
     context.subscriptions.push(vscode.languages.registerDocumentFormattingEditProvider(PYTHON, new PythonFormattingEditProvider(context, pythonSettings, outChannel)));
 
-    // var isWin = /^win/.test(process.platform);
-    // if (!isWin) {
-    context.subscriptions.push(new LintProvider(context, pythonSettings, outChannel));//).register(rootDir);
-    //disposables.forEach(d=> context.subscriptions.push(d));
-    // }
+    context.subscriptions.push(new LintProvider(context, pythonSettings, outChannel));
 }
 
 // this method is called when your extension is deactivated
diff --git a/src/client/providers/jediProxy.ts b/src/client/providers/jediProxy.ts
@@ -6,6 +6,7 @@ import * as child_process from 'child_process';
 import * as vscode from 'vscode';
 import * as path from 'path';
 import * as settings from './../common/configSettings';
+import * as logger from './../common/logger';
 
 var proc: child_process.ChildProcess;
 var pythonSettings = new settings.PythonSettings();
@@ -163,12 +164,13 @@ function killProcess() {
 }
 
 function handleError(source: string, errorMessage: string) {
-    console.error(`Error (${source}) ${errorMessage}`);
+    logger.error(source + ' jediProxy', `Error (${source}) ${errorMessage}`);
     vscode.window.showErrorMessage(`There was an error in the python extension. Error ${errorMessage}`);
 }
 
 function spawnProcess(dir: string) {
     try {
+        logger.log('child_process.spawn in jediProxy', 'Value of pythonSettings.pythonPath is :' + pythonSettings.pythonPath);
         proc = child_process.spawn(pythonSettings.pythonPath, ["-u", "completion.py"], {
             cwd: dir
         });
@@ -180,20 +182,23 @@ function spawnProcess(dir: string) {
         handleError("stderr", data);
     });
     proc.on("end", (end) => {
-        console.error("End - " + end);
+        logger.error('spawnProcess.end', "End - " + end);
     });
     proc.on("error", error => {
         handleError("error", error);
     });
 
     proc.stdout.on("data", (data) => {
+        //Possible there was an exception in parsing the data returned
+        //So append the data then parse it
         var dataStr = previousData = previousData + data + ""
         var responses: any[];
         try {
             responses = dataStr.split("\n").filter(line=> line.length > 0).map(resp=> JSON.parse(resp));
             previousData = "";
         }
         catch (ex) {
+            //Possible we've only received part of the data, hence don't clear previousData
             handleError("stdout", ex.message);
             return;
         }
