Update to use DebugConfigurationProvider

Fix #1046
Fix warning in status bar about ThemeColor

This fix requires PSES PR 556 to eliminate one PSES cause of the debug adapter to crash.

Also npm generated a package-lock.json file which, from what I've read, should be checked in.  I haven't included it in this PR - yet.  Thoughts?

Also, I updated min VSCode version to 1.17.0.  I'm not sure when the new DebugConfigurationProvider API was intro'd.  I  have tested with 1.17.2 and it works there so I'm reasonably confident it will work in 1.17.0.  We might be able to reach back a bit further.  We'd have to find out when this API was intro'd.

Author: rkeithhill

.vscode/settings.json

@@ -4,6 +4,13 @@
     "editor.insertSpaces": true,
     "files.trimTrailingWhitespace": true,
 
+    "search.exclude": {
+        "**/node_modules": true,
+        "**/bower_components": true,
+        "logs/": true,
+        "out/": true
+    },
+
     // Lock the TypeScript SDK path to the version we use
     "typescript.tsdk": "./node_modules/typescript/lib"
 }

package.json

@@ -5,7 +5,7 @@
   "publisher": "ms-vscode",
   "description": "Develop PowerShell scripts in Visual Studio Code!",
   "engines": {
-    "vscode": "^1.12.0"
+    "vscode": "^1.17.0"
   },
   "license": "SEE LICENSE IN LICENSE.txt",
   "homepage": "https://github.com/PowerShell/vscode-powershell/blob/master/README.md",
@@ -26,10 +26,10 @@
   },
   "main": "./out/src/main",
   "activationEvents": [
+    "onDebug",
     "onLanguage:powershell",
     "onCommand:PowerShell.NewProjectFromTemplate",
     "onCommand:PowerShell.OpenExamplesFolder",
-    "onCommand:PowerShell.StartDebugSession",
     "onCommand:PowerShell.PickPSHostProcess",
     "onCommand:PowerShell.SpecifyScriptArgs",
     "onCommand:PowerShell.ShowSessionConsole",
@@ -169,18 +169,20 @@
       {
         "name": "pester",
         "owner": "powershell",
-        "fileLocation": ["absolute"],
+        "fileLocation": [
+          "absolute"
+        ],
         "severity": "error",
         "pattern": [
-            {
-                "regexp": "^\\s*(\\[-\\]\\s*.*?)(\\d+)ms\\s*$",
-                "message": 1
-            },
-            {
-                "regexp": "^\\s+at\\s+[^,]+,\\s*(.*?):\\s+line\\s+(\\d+)$",
-                "file": 1,
-                "line": 2
-            }
+          {
+            "regexp": "^\\s*(\\[-\\]\\s*.*?)(\\d+)ms\\s*$",
+            "message": 1
+          },
+          {
+            "regexp": "^\\s+at\\s+[^,]+,\\s*(.*?):\\s+line\\s+(\\d+)$",
+            "file": 1,
+            "line": 2
+          }
         ]
       }
     ],
@@ -207,7 +209,6 @@
         "languages": [
           "powershell"
         ],
-        "startSessionCommand": "PowerShell.StartDebugSession",
         "configurationSnippets": [
           {
             "label": "PowerShell: Launch Current File",
@@ -242,7 +243,9 @@
               "request": "launch",
               "name": "PowerShell Launch Current File w/Args Prompt",
               "script": "^\"\\${file}\"",
-              "args": [ "^\"\\${command:SpecifyScriptArgs}\"" ],
+              "args": [
+                "^\"\\${command:SpecifyScriptArgs}\""
+              ],
               "cwd": "^\"\\${file}\""
             }
           },
@@ -365,7 +368,9 @@
             "request": "launch",
             "name": "PowerShell Launch Current File w/Args Prompt",
             "script": "${file}",
-            "args": [ "${command:SpecifyScriptArgs}" ],
+            "args": [
+              "${command:SpecifyScriptArgs}"
+            ],
             "cwd": "${file}"
           },
           {
@@ -425,7 +430,7 @@
           "description": "Specifies the path to a PowerShell Script Analyzer settings file. To override the default settings for all projects, enter an absolute path, or enter a path relative to your workspace."
         },
         "powershell.codeFormatting.preset": {
-          "type":"string",
+          "type": "string",
           "enum": [
             "Custom",
             "Allman",

src/controls/animatedStatusBar.ts

@@ -5,6 +5,7 @@
 import {
     StatusBarItem,
     StatusBarAlignment,
+    ThemeColor,
     Disposable,
     window} from "vscode";
 
@@ -49,11 +50,11 @@ class AnimatedStatusBarItem implements StatusBarItem {
         this.statusBarItem.tooltip = value;
     }
 
-    public get color(): string {
+    public get color(): string | ThemeColor {
         return this.statusBarItem.color;
     }
 
-    public set color(value: string) {
+    public set color(value: string | ThemeColor) {
         this.statusBarItem.color = value;
     }
 

src/features/DebugSession.ts

@@ -5,41 +5,45 @@
 import vscode = require('vscode');
 import utils = require('../utils');
 import Settings = require('../settings');
+import { dirname } from 'path';
 import { IFeature } from '../feature';
 import { SessionManager } from '../session';
 import { LanguageClient, RequestType, NotificationType } from 'vscode-languageclient';
+import { CancellationToken, DebugConfiguration, DebugConfigurationProvider,
+    ExtensionContext, ProviderResult, WorkspaceFolder } from 'vscode';
 
-export namespace StartDebuggerNotification {
-    export const type = new NotificationType<void, void>('powerShell/startDebugger');
-}
-
-export class DebugSessionFeature implements IFeature {
+export class DebugSessionFeature implements IFeature, DebugConfigurationProvider {
 
     private sessionCount: number = 1;
     private command: vscode.Disposable;
     private examplesPath: string;
 
-    constructor(private sessionManager: SessionManager) {
-        this.command = vscode.commands.registerCommand(
-            'PowerShell.StartDebugSession',
-            config => { this.startDebugSession(config); });
+    constructor(context: ExtensionContext, private sessionManager: SessionManager) {
+        // Register a debug configuration provider
+        context.subscriptions.push(vscode.debug.registerDebugConfigurationProvider('PowerShell', this));
     }
 
     public setLanguageClient(languageClient: LanguageClient) {
-        languageClient.onNotification(
-            StartDebuggerNotification.type,
-            none => this.startDebugSession({
-                request: 'launch',
-                type: 'PowerShell',
-                name: 'PowerShell Interactive Session'
-            }));
     }
 
     public dispose() {
         this.command.dispose();
     }
 
-    private startDebugSession(config: any) {
+    // DebugConfigurationProvider method
+    provideDebugConfigurations(
+        folder: WorkspaceFolder | undefined,
+        token?: CancellationToken): ProviderResult<DebugConfiguration[]> {
+
+        // Currently all debugger initialConfigurations are specified in package.json
+        return [];
+    }
+
+    // DebugConfigurationProvider method
+    resolveDebugConfiguration(
+        folder: WorkspaceFolder | undefined,
+        config: DebugConfiguration,
+        token?: CancellationToken): ProviderResult<DebugConfiguration> {
 
         let currentDocument = vscode.window.activeTextEditor.document;
         let debugCurrentScript = (config.script === "${file}") || !config.request;
@@ -146,27 +150,14 @@ export class DebugSessionFeature implements IFeature {
                 .start(`DebugSession-${this.sessionCount++}`)
                 .then(
                     sessionDetails => {
-                        this.startDebugger(
-                            config,
-                            sessionFilePath,
-                            sessionDetails);
+                        utils.writeSessionFile(sessionFilePath, sessionDetails);
                     });
         }
         else {
-            this.startDebugger(
-                config,
-                sessionFilePath,
-                this.sessionManager.getSessionDetails());
+            utils.writeSessionFile(sessionFilePath, this.sessionManager.getSessionDetails());
         }
-    }
 
-    private startDebugger(
-        config: any,
-        sessionFilePath: string,
-        sessionDetails: utils.EditorServicesSessionDetails) {
-
-        utils.writeSessionFile(sessionFilePath, sessionDetails);
-        vscode.commands.executeCommand('vscode.startDebug', config);
+        return config;
     }
 }
 
@@ -204,7 +195,7 @@ export class SpecifyScriptArgsFeature implements IFeature {
         this.command.dispose();
     }
 
-    private specifyScriptArguments(): Thenable<string[]> {
+    private specifyScriptArguments(): Thenable<string[] | string> {
         const powerShellDbgScriptArgsKey = 'powerShellDebugScriptArgs';
 
         let options: vscode.InputBoxOptions = {
@@ -225,6 +216,7 @@ export class SpecifyScriptArgsFeature implements IFeature {
                 if (this.emptyInputBoxBugFixed) {
                    this.context.workspaceState.update(powerShellDbgScriptArgsKey, text);
                 }
+
                 return new Array(text);
             }
 

src/main.ts

@@ -121,7 +121,7 @@ export function activate(context: vscode.ExtensionContext): void {
         new NewFileOrProjectFeature(),
         new DocumentFormatterFeature(logger),
         new RemoteFilesFeature(),
-        new DebugSessionFeature(sessionManager),
+        new DebugSessionFeature(context, sessionManager),
         new PickPSHostProcessFeature(),
         new SpecifyScriptArgsFeature(context),
         new HelpCompletionFeature(),