Add new log setting, add troubleshooting section to readme

The new settings allows to log all communication between the adapter and
VS Code to the debug console without having the extension run in server
mode.

Author: felixfbecker

README.md

@@ -58,6 +58,12 @@ Example:
 Both paths are normalized, so you can use slashes or backslashes no matter of the OS you're running.
 If no `localSourceRoot` is specified, the project root is assumed.
 
+Troubleshooting
+---------------
+When you are facing problems, please don't send me private emails, instead ask on
+[Gitter](https://gitter.im/felixfbecker/vscode-php-debug) or if you think there is a bug in the adapter, [open an issue](https://github.com/felixfbecker/vscode-php-debug/issues).
+If it fails with your ultra-awesome MVC app, please first try it on a dead-simple test.php (like the one in the [testproject](https://github.com/felixfbecker/vscode-php-debug/tree/master/testproject)). Please provide some info by setting `xdebug.remote_log = /path/to/logfile` in your php.ini (you will need to restart your webserver), `"log": true` in your launch.json and posting the two logs.
+
 FAQ
 ---
 
@@ -81,7 +87,7 @@ PS C:\Users\felix\github\vscode-php-debug> code .\testproject\ --extensionDevelo
 ```
 
 VS Code will open an "Extension Development Host" with the debug adapter running. Open `.vscode/launch.json` and
-uncomment the `debugServer` configuration line. Hit `F5` to start a debugging session. 
+uncomment the `debugServer` configuration line. Hit `F5` to start a debugging session.
 Now, you can debug the testproject like specified above and set breakpoints inside your first VS Code instance to step through the adapter code.
 
 [![Gitter](https://badges.gitter.im/felixfbecker/vscode-php-debug.svg)](https://gitter.im/felixfbecker/vscode-php-debug?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

package.json

@@ -88,6 +88,10 @@
               "cwd": {
                 "type": "string",
                 "description": "The current working directory, by default the project root"
+              },
+              "log": {
+                "type": "boolean",
+                "description": "If true, will log all communication between VS Code and the adapter"
               }
             }
           }

src/phpDebug.ts

@@ -48,6 +48,8 @@ interface LaunchRequestArguments extends VSCodeDebugProtocol.LaunchRequestArgume
     localSourceRoot?: string;
     /** The current working directory, by default the project root */
     cwd?: string;
+    /** If true, will log all communication between VS Code and the adapter to the console */
+    log: boolean;
 }
 
 class PhpDebugSession extends vscode.DebugSession {
@@ -238,20 +240,29 @@ class PhpDebugSession extends vscode.DebugSession {
 
     /** Logs all requests before dispatching */
     protected dispatchRequest(request: VSCodeDebugProtocol.Request) {
-        console.log(`\n\n-> ${request.command}Request`);
-        console.log(util.inspect(request, {depth: null}));
+        const log = `-> ${request.command}Request\n${util.inspect(request, {depth: null})}\n\n`;
+        console.log(log);
+        if (this._args && this._args.log) {
+            this.sendEvent(new vscode.OutputEvent(log));
+        }
         super.dispatchRequest(request);
     }
 
     public sendEvent(event: VSCodeDebugProtocol.Event): void {
-		console.log(`\n\n<- ${event.event}Event`)
-        console.log(util.inspect(event, {depth: null}));
+        const log = `-> ${event.event}Event\n${util.inspect(event, {depth: null})}\n\n`;
+        console.log(log);
+        if (this._args && this._args.log && !(event instanceof vscode.OutputEvent)) {
+            this.sendEvent(new vscode.OutputEvent(log));
+        }
         super.sendEvent(event);
 	}
 
     public sendResponse(response: VSCodeDebugProtocol.Response) {
-        console[response.success ? 'log' : 'error'](`\n\n<- ${response.command}Response`)
-        console[response.success ? 'log' : 'error'](util.inspect(response, {depth: null}));
+        const log = `-> ${response.command}Response\n${util.inspect(response, {depth: null})}\n\n`;
+        console[response.success ? 'log' : 'error'](log);
+        if (this._args && this._args.log) {
+            this.sendEvent(new vscode.OutputEvent(log, response.success ? 'stdout' : 'stderr'));
+        }
         super.sendResponse(response);
     }
 

testproject/.vscode/launch.json

@@ -6,7 +6,8 @@
 			"name": "Listen for XDebug",
 			"type": "php",
 			"request": "launch",
-			"port": 9000
+			"port": 9000,
+            "log": true
 		}
 	]
 }