Merge pull request #345 from DustinCampbell/merge-dev-into-master

Merge dev into master

Author: DustinCampbell

README.md

@@ -25,6 +25,11 @@ Please file any issues at https://github.com/OmniSharp/omnisharp-vscode/issues.
 The C# extension now supports basic debugging capabilities! See http://aka.ms/vscclrdebugger for details.
 
 ### Development
+
+First install:
+* Node.js (newer than 4.3.1)
+* Npm (newer 2.14.12)
+
 To **run and develop** do the following:
 
 * Run `npm i`

debugger.md

@@ -15,8 +15,8 @@ Install Visual Studio Code (VSC). Pick the latest VSC version from here: https:/
 
 If you are not sure what version you have, you can see your version of VS Code:
 
-* **OSX:** Code->Abort Visual Studio Code
-* **Windows / Linux:** Help->Abort
+* **OSX:** Code->About Visual Studio Code
+* **Windows / Linux:** Help->About
 
 ##### 2: Install .NET command line tools
 Install the .NET Core command line tools (CLI) by following the installation part of the instructions here: http://dotnet.github.io/getting-started

package.json

@@ -25,7 +25,6 @@
     "decompress": "^3.0.0",
     "del": "^2.0.2",
     "fs-extra-promise": "^0.3.1",
-    "run-in-terminal": "*",
     "semver": "*",
     "vscode-debugprotocol": "^1.6.1",
     "vscode-extension-telemetry": "0.0.4",
@@ -295,7 +294,7 @@
               "processId": {
                 "type": "integer",
                 "description": "The process id to attach to. If this is used, 'processName' should not be used.",
-                "default": ""
+                "default": 0
               },
               "sourceFileMap": {
                 "type": "object",
@@ -359,7 +358,7 @@
             "name": ".NET Core Attach",
             "type": "coreclr",
             "request": "attach",
-            "processName": "<example>"
+            "processId": 0
           }
         ]
       }

src/assets.ts

@@ -45,7 +45,7 @@ interface WebLaunchConfiguration extends ConsoleLaunchConfiguration {
 }
 
 interface AttachConfiguration extends DebugConfiguration {
-    processName: string
+    processId: number
 }
 
 interface Paths {
@@ -173,7 +173,7 @@ function createAttachConfiguration(): AttachConfiguration {
         name: '.NET Core Attach',
         type: 'coreclr',
         request: 'attach',
-        processName: '<example>'
+        processId: 0
     }
 }
 

src/coreclr-debug/main.ts

@@ -57,7 +57,7 @@ export function activate(context: vscode.ExtensionContext, reporter: TelemetryRe
 
     writeInstallBeginFile().then(function() {
         installStage = 'writeProjectJson';
-        return writeProjectJson();
+        return writeProjectJson(_channel);
     }).then(function() {
         installStage = 'dotnetRestore'
         return spawnChildProcess('dotnet', ['--verbose', 'restore', '--configfile', 'NuGet.config'], _channel, _util.coreClrDebugDir())  
@@ -185,7 +185,7 @@ function removeLibCoreClrTraceProvider() : Promise<void>
                 if (err) {
                     reject(err.code);
                 } else {
-                    _channel.appendLine('Succesfully deleted ' + filePath);
+                    _channel.appendLine('Successfully deleted ' + filePath);
                     resolve();
                 }
             });
@@ -240,12 +240,16 @@ function ensureAd7EngineExists(channel: vscode.OutputChannel, outputDirectory: s
     });
 }
 
-function writeProjectJson(): Promise<void> {
-    return new Promise<void>(function(resolve, reject) {
-        var projectJson = createProjectJson(CoreClrDebugUtil.getPlatformRuntimeId());
+function writeProjectJson(channel: vscode.OutputChannel): Promise<void> {
+    return new Promise<void>(function (resolve, reject) {
+        const projectJsonPath = path.join(_util.coreClrDebugDir(), 'project.json');
+        _channel.appendLine('Creating ' + projectJsonPath);
+
+        const projectJson = createProjectJson(getPlatformRuntimeId(channel));
 
-        fs.writeFile(path.join(_util.coreClrDebugDir(), 'project.json'), JSON.stringify(projectJson, null, 2), {encoding: 'utf8'}, function(err) {
-           if (err) {
+        fs.writeFile(projectJsonPath, JSON.stringify(projectJson, null, 2), {encoding: 'utf8'}, function(err) {
+            if (err) {
+               channel.appendLine('Error: Unable to write to project.json: ' + err.message);
                reject(err.code);
            }
            else {
@@ -255,6 +259,71 @@ function writeProjectJson(): Promise<void> {
     });
 }
 
+function getPlatformRuntimeId(channel: vscode.OutputChannel) : string {
+    switch (process.platform) {
+        case 'win32':
+            return 'win7-x64';
+        case 'darwin':
+            return getDotnetRuntimeId(channel);
+        case 'linux':
+            return getDotnetRuntimeId(channel);
+        default:
+            channel.appendLine('Error: Unsupported platform ' + process.platform);
+            throw Error('Unsupported platform ' + process.platform);
+    }
+}
+    
+function getDotnetRuntimeId(channel: vscode.OutputChannel): string {
+    channel.appendLine("Starting 'dotnet --info'");
+
+    const cliVersionErrorMessage = "Ensure that .NET Core CLI Tools version >= 1.0.0-beta-002173 is installed. Run 'dotnet --version' to see what version is installed.";
+
+    let child = child_process.spawnSync('dotnet', ['--info'], { cwd: _util.coreClrDebugDir() });
+
+    if (child.stderr.length > 0) {
+        channel.append('Error: ' + child.stderr.toString());
+    }
+    const out = child.stdout.toString();
+    if (out.length > 0) {
+        channel.append(out);
+    }
+
+    if (child.status !== 0) {
+        const message = `Error: 'dotnet --info' failed with error ${child.status}`;
+        channel.appendLine(message);
+        channel.appendLine(cliVersionErrorMessage);
+        throw new Error(message);
+    }
+
+    if (out.length === 0) {
+        const message = "Error: 'dotnet --info' provided no output";
+        channel.appendLine(message);
+        channel.appendLine(cliVersionErrorMessage);
+        throw new Error(message);
+    }
+
+    let lines = out.split('\n');
+    let ridLine = lines.filter(function (value) {
+        return value.trim().startsWith('RID:');
+    });
+
+    if (ridLine.length < 1) {
+        channel.appendLine("Error: Cannot find 'RID' property");
+        channel.appendLine(cliVersionErrorMessage);
+        throw new Error('Cannot obtain Runtime ID from dotnet cli');
+    }
+
+    let rid = ridLine[0].split(':')[1].trim();
+
+    if (!rid) {
+        channel.appendLine("Error: Unable to parse 'RID' property.");
+        channel.appendLine(cliVersionErrorMessage);
+        throw new Error('Unable to determine Runtime ID');
+    }
+
+    return rid;
+}
+
 function createProjectJson(targetRuntime: string): any
 {
     let projectJson = {

src/coreclr-debug/util.ts

@@ -112,40 +112,6 @@ export default class CoreClrDebugUtil
         }
     }
 
-    static getPlatformRuntimeId() : string {
-        switch(process.platform) {
-            case 'win32':
-                return 'win7-x64';
-            case 'darwin':
-                return CoreClrDebugUtil.getDotnetRuntimeId();
-            case 'linux':
-                return CoreClrDebugUtil.getDotnetRuntimeId();
-            default:
-                throw Error('Unsupported platform ' + process.platform);
-        }
-    }
-    
-    static getDotnetRuntimeId() : string {
-        let out = child_process.execSync('dotnet --info').toString();
-       
-        let lines = out.split('\n');
-        let ridLine = lines.filter(function(value) {
-            return value.trim().startsWith('RID');
-        });
-        
-        if (ridLine.length < 1) {
-            throw new Error('Cannot obtain Runtime ID from dotnet cli');
-        }
-        
-        let rid = ridLine[0].split(':')[1].trim();
-        
-        if (!rid) {
-            throw new Error('Unable to determine Runtime ID');
-        }
-        
-        return rid;
-    }
-    
     /** Used for diagnostics only */
     logToFile(message: string): void {
         let logFolder = path.resolve(this.coreClrDebugDir(), "extension.log");

src/features/commands.ts

@@ -8,11 +8,13 @@
 import {OmnisharpServer} from '../omnisharpServer';
 import * as serverUtils from '../omnisharpUtils';
 import findLaunchTargets from '../launchTargetFinder';
-import {runInTerminal} from 'run-in-terminal';
+import * as cp from 'child_process';
+import * as fs from 'fs-extra-promise';
 import * as path from 'path';
+import * as protocol from '../protocol';
 import * as vscode from 'vscode';
 
-const isWindows = process.platform === 'win32';
+let channel = vscode.window.createOutputChannel('.NET');
 
 export default function registerCommands(server: OmnisharpServer, extensionPath: string) {
 	let d1 = vscode.commands.registerCommand('o.restart', () => server.restart());
@@ -57,6 +59,26 @@ interface Command {
 	execute(): Thenable<any>;
 }
 
+function projectsToCommands(projects: protocol.DotNetProject[]): Promise<Command>[] {
+	return projects.map(project => {
+		let projectDirectory = project.Path;
+
+		return fs.lstatAsync(projectDirectory).then(stats => {
+			if (stats.isFile()) {
+				projectDirectory = path.dirname(projectDirectory);
+			}
+
+			return {
+				label: `dotnet restore - (${project.Name || path.basename(project.Path)})`,
+				description: projectDirectory,
+				execute() {
+					return runDotnetRestore(projectDirectory);
+				}
+			};
+		});
+	});
+}
+
 export function dotnetRestoreAllProjects(server: OmnisharpServer) {
 
 	if (!server.isRunning()) {
@@ -65,23 +87,15 @@ export function dotnetRestoreAllProjects(server: OmnisharpServer) {
 
 	return serverUtils.requestWorkspaceInformation(server).then(info => {
 
-		let commands: Command[] = [];
+		if (!('DotNet in info') || info.DotNet.Projects.length < 1) {
+			return Promise.reject("No .NET Core projects found");
+		}
+		
+		let commandPromises = projectsToCommands(info.DotNet.Projects);
 
-        if ('DotNet' in info && info.DotNet.Projects.length > 0) {
-            for (let project of info.DotNet.Projects) {
-                commands.push({
-                    label: `dotnet restor - (${project.Name || path.basename(project.Path)})`,
-                    description: path.dirname(project.Path),
-                    execute() {
-                        return runInTerminal('dotnet', ['restore'], {
-                            cwd: path.dirname(project.Path)
-                        });
-                    }
-                });
-            }
-        }
-
-		return vscode.window.showQuickPick(commands).then(command => {
+		return Promise.all(commandPromises).then(commands => {
+			return vscode.window.showQuickPick(commands);
+		}).then(command => {
 			if (command) {
 				return command.execute();
 			}
@@ -91,17 +105,42 @@ export function dotnetRestoreAllProjects(server: OmnisharpServer) {
 
 export function dotnetRestoreForProject(server: OmnisharpServer, fileName: string) {
 
+	if (!server.isRunning()) {
+		return Promise.reject('OmniSharp server is not running.');
+	}
+
 	return serverUtils.requestWorkspaceInformation(server).then(info => {
-        if ('DotNet' in info && info.DotNet.Projects.length > 0) {
-            for (let project of info.DotNet.Projects) {
-                if (project.Path === path.dirname(fileName)) {
-                    return runInTerminal('dotnet', ['restore', fileName], {
-                        cwd: path.dirname(project.Path)
-                    });
-                }
-            }
-        }
-
-		return Promise.reject(`Failed to execute restore, try to run 'dotnet restore' manually for ${fileName}.`);
+
+		if (!('DotNet in info') || info.DotNet.Projects.length < 1) {
+			return Promise.reject("No .NET Core projects found");
+		}
+		
+		let directory = path.dirname(fileName);
+		
+		for (let project of info.DotNet.Projects) {
+			if (project.Path === directory) {
+				return runDotnetRestore(directory, fileName);
+			}
+		}
+	});
+}
+
+function runDotnetRestore(cwd: string, fileName?: string) {
+	return new Promise<cp.ChildProcess>((resolve, reject) => {
+		channel.clear();
+		channel.show();
+		
+		let cmd = 'dotnet restore';
+		if (fileName) {
+			cmd = `${cmd} "${fileName}"`
+		}
+		
+		return cp.exec(cmd, {cwd: cwd, env: process.env}, (err, stdout, stderr) => {
+			channel.append(stdout.toString());
+			channel.append(stderr.toString());
+			if (err) {
+				channel.append('ERROR: ' + err);
+			}
+		});		
 	});
 }

src/features/completionItemProvider.ts

@@ -5,7 +5,7 @@
 
 'use strict';
 
-import {plain} from './documentation';
+import {extractSummaryText} from './documentation';
 import AbstractSupport from './abstractProvider';
 import * as protocol from '../protocol';
 import * as serverUtils from '../omnisharpUtils';
@@ -26,6 +26,7 @@ export default class OmniSharpCompletionItemProvider extends AbstractSupport imp
 		req.WordToComplete = wordToComplete;
 		req.WantDocumentationForEveryCompletionResult = true;
 		req.WantKind = true;
+		req.WantReturnType = true;
 
 		return serverUtils.autoComplete(this._server, req).then(values => {
 
@@ -40,14 +41,15 @@ export default class OmniSharpCompletionItemProvider extends AbstractSupport imp
 			// group by code snippet
 			for (let value of values) {
 				let completion = new CompletionItem(value.CompletionText.replace(/\(|\)|<|>/g, ''));
-				completion.detail = value.DisplayText;
-				completion.documentation = plain(value.Description);
+				completion.detail = value.ReturnType ? `${value.ReturnType} ${value.DisplayText}` : value.DisplayText;
+				completion.documentation = extractSummaryText(value.Description);
 				completion.kind = _kinds[value.Kind] || CompletionItemKind.Property;
 
 				let array = completions[completion.label];
 				if (!array) {
 					completions[completion.label] = [completion];
-				} else {
+				}
+				else {
 					array.push(completion);
 				}
 			}
@@ -62,10 +64,12 @@ export default class OmniSharpCompletionItemProvider extends AbstractSupport imp
 					// remove non overloaded items
 					delete completions[key];
 
-				} else {
+				}
+				else {
 					// indicate that there is more
 					suggestion.detail = `${suggestion.detail} (+ ${overloadCount} overload(s))`;
 				}
+				
 				result.push(suggestion);
 			}