Fix merge conflict with 'master'

Author: Kapil Borle

.vscodeignore

@@ -7,5 +7,6 @@ build/**
 bin/EditorServices.log
 bin/DebugAdapter.log
 bin/*.vshost.*
+bin/PowerShell/**
 logs/**
 sessions/**

examples/PSScriptAnalyzerSettings.psd1

@@ -16,6 +16,7 @@
  'PSReservedParams',
  'PSShouldProcess',
  'PSUseApprovedVerbs',
+ 'PSAvoidUsingAliases',
  'PSUseDeclaredVarsMoreThanAssigments')
 
  # Do not analyze the following rules. Use ExcludeRules when you have

package.json

@@ -27,7 +27,9 @@
  "main": "./out/main",
  "activationEvents": [
  "onLanguage:powershell",
- "onCommand:PowerShell.NewProjectFromTemplate"
+ "onCommand:PowerShell.NewProjectFromTemplate",
+ "onCommand:PowerShell.OpenExamplesFolder",
+ "onCommand:PowerShell.StartDebugSession"
  ],
  "dependencies": {
  "vscode-languageclient": "1.3.1"
@@ -139,6 +141,11 @@
  "command": "PowerShell.NewProjectFromTemplate",
  "title": "Create New Project from Plaster Template",
  "category": "PowerShell"
+ },
+ {
+ "command": "PowerShell.OpenExamplesFolder",
+ "title": "Open Examples Folder",
+ "category": "PowerShell"
  }
  ],
  "snippets": [
@@ -157,10 +164,11 @@
  },
  "program": "./out/debugAdapter.js",
  "runtime": "node",
-
+ "languages": ["powershell"],
+ "startSessionCommand": "PowerShell.StartDebugSession",
  "configurationSnippets": [
  {
- "label": "PowerShell: Launch Current File Configuration",
+ "label": "PowerShell: Launch Current Script Configuration",
  "description": "A new configuration for launching the current opened PowerShell script",
  "body": {
  "type": "PowerShell",
@@ -172,7 +180,7 @@
  }
  },
  {
- "label": "PowerShell: Launch Configuration",
+ "label": "PowerShell: Launch Script Configuration",
  "description": "A new configuration for launching a PowerShell script",
  "body": {
  "type": "PowerShell",
@@ -182,22 +190,39 @@
  "args": [],
  "cwd": "^\"\\${workspaceRoot}\""
  }
+ },
+ {
+ "label": "PowerShell: Attach to PowerShell Process Configuration",
+ "description": "A new configuration for debugging a runspace in another process.",
+ "body": {
+ "type": "PowerShell",
+ "request": "attach",
+ "name": "PowerShell Attach to Process",
+ "processId": "${ProcessId}",
+ "runspaceId": "1"
+ }
+ },
+ {
+ "label": "PowerShell: Launch Interactive Session Configuration",
+ "description": "A new configuration for debugging an interactive session.",
+ "body": {
+ "type": "PowerShell",
+ "request": "launch",
+ "name": "PowerShell Interactive Session"
+ }
  }
  ],
 
  "configurationAttributes": {
  "launch": {
- "required": [
- "script"
- ],
  "properties": {
  "program": {
  "type": "string",
  "description": "Deprecated. Please use the 'script' property instead to specify the absolute path to the PowerShell script to launch under the debugger."
  },
  "script": {
  "type": "string",
- "description": "Absolute path to the PowerShell script to launch under the debugger."
+ "description": "Optional: Absolute path to the PowerShell script to launch under the debugger."
  },
  "args": {
  "type": "array",
@@ -213,6 +238,23 @@
  "default": "${workspaceRoot}"
  }
  }
+ },
+ "attach": {
+ "properties": {
+ "computerName": {
+ "type": "string",
+ "description": "Optional: The computer name to which a remote session will be established. Works only on PowerShell 4 and above."
+ },
+ "processId": {
+ "type": "number",
+ "description": "The ID of the process to be attached. Works only on PowerShell 5 and above."
+ },
+ "runspaceId": {
+ "type": "number",
+ "description": "Optional: The ID of the runspace to debug in the attached process. Defaults to 1. Works only on PowerShell 5 and above.",
+ "default": 1
+ }
+ }
  }
  },
  "initialConfigurations": [
@@ -223,6 +265,18 @@
  "script": "${file}",
  "args": [],
  "cwd": "${file}"
+ },
+ {
+ "type": "PowerShell",
+ "request": "attach",
+ "name": "PowerShell Attach",
+ "processId": "12345"
+ },
+ {
+ "type": "PowerShell",
+ "request": "launch",
+ "name": "PowerShell Interactive Session",
+ "cwd": "${workspaceRoot}"
  }
  ]
  }

snippets/PowerShell.json

@@ -1,4 +1,65 @@
 {
+ "ModuleManifest": {
+ "prefix": "manifest",
+ "body": [
+ "@{",
+ "\t# If authoring a script module, the RootModule is your .psm1 file",
+ "\tRootModule = '${module:MyModule}.psm1'",
+ "",
+ "\tAuthor = '${author:Cool Person <coolperson@email.local>}",
+ "",
+ "\tCompanyName = '${company:Contoso Inc.}'",
+ "",
+ "\tModuleVersion = '${ModuleVersion:0.1}'",
+ "",
+ "\tGUID = '<pasteNewGUIDhere>'",
+ "",
+ "\tCopyright = '2017 ${company:Copyright Holder}",
+ "",
+ "\tDescription = '${Description:What does this module do?}'",
+ "",
+ "\t# Minimum PowerShell version supported by this module (optional, recommended)",
+ "\t# PowerShellVersion = ''",
+ "",
+ "\t# Which PowerShell Editions does this module work with? (Core, Desktop)",
+ "\tCompatiblePSEditions = @('Desktop', 'Core')",
+ "",
+ "\t# Which PowerShell functions are exported from your module? (eg. Get-CoolObject)",
+ "\tFunctionsToExport = @('')",
+ "",
+ "\t# Which PowerShell aliases are exported from your module? (eg. gco)",
+ "\tAliasesToExport = @('')",
+ "",
+ "\t# Which PowerShell variables are exported from your module? (eg. Fruits, Vegetables)",
+ "\tVariablesToExport = @('')",
+ "",
+ "\t# PowerShell Gallery: Define your module's metadata",
+ "\tPrivateData = @{",
+ "\t\tPSData = @{",
+ "\t\t\t# What keywords represent your PowerShell module? (eg. cloud, tools, framework, vendor)",
+ "\t\t\tTags = @('${tag1:cooltag1}', '${tag2:cooltag2}')",
+ "",
+ "\t\t\t# What software license is your code being released under? (see https://opensource.org/licenses)",
+ "\t\t\tLicenseUri = ''",
+ "",
+ "\t\t\t# What is the URL to your project's website?",
+ "\t\t\tProjectUri = ''",
+ "",
+ "\t\t\t# What is the URI to a custom icon file for your project? (optional)",
+ "\t\t\tIconUri = ''",
+ "",
+ "\t\t\t# What new features, bug fixes, or deprecated features, are part of this release?",
+ "\t\t\tReleaseNotes = @'",
+ "'@",
+ "\t\t}",
+ "\t}",
+ "",
+ "\t# If your module supports updateable help, what is the URI to the help archive? (optional)",
+ "\t# HelpInfoURI = ''",
+ "}"
+ ],
+ "description": "Basic skeleton for a PowerShell module manifest, complete with PowerShell Gallery metadata."
+ },
  "Example-Class": {
  "prefix": "ex-class",
  "body": [
@@ -810,4 +871,4 @@
  ],
  "description": "sequence snippet (for use inside a workflow)"
  }
-}
+}

src/debugAdapter.ts

@@ -26,49 +26,107 @@ var debugAdapterLogWriter =
 // debug server
 process.stdin.pause();
 
-// Read the details of the current session to learn
-// the connection details for the debug service
-let sessionDetails = utils.readSessionFile();
-
-// Establish connection before setting up the session
-debugAdapterLogWriter.write("Connecting to port: " + sessionDetails.debugServicePort + "\r\n");
-let debugServiceSocket = net.connect(sessionDetails.debugServicePort, '127.0.0.1');
-
-// Write any errors to the log file
-debugServiceSocket.on(
- 'error',
- (e) => debugAdapterLogWriter.write("Socket connect ERROR: " + e + "\r\n"));
-
-// Route any output from the socket through stdout
-debugServiceSocket.on(
- 'data',
- (data: Buffer) => process.stdout.write(data));
-
-// Wait for the connection to complete
-debugServiceSocket.on(
- 'connect',
- () => {
- debugAdapterLogWriter.write("Connected to socket!\r\n\r\n");
-
- // When data comes on stdin, route it through the socket
- process.stdin.on(
- 'data',
- (data: Buffer) => debugServiceSocket.write(data));
-
- // Resume the stdin stream
- process.stdin.resume();
- });
-
-// When the socket closes, end the session
-debugServiceSocket.on(
- 'close',
- () => {
- debugAdapterLogWriter.write("Socket closed, shutting down.");
-
- // Close after a short delay to give the client time
- // to finish up
- setTimeout(() => {
+function startDebugging() {
+ // Read the details of the current session to learn
+ // the connection details for the debug service
+ let sessionDetails = utils.readSessionFile();
+
+ // Establish connection before setting up the session
+ debugAdapterLogWriter.write("Connecting to port: " + sessionDetails.debugServicePort + "\r\n");
+
+ let isConnected = false;
+ let debugServiceSocket = net.connect(sessionDetails.debugServicePort, '127.0.0.1');
+
+ // Write any errors to the log file
+ debugServiceSocket.on(
+ 'error',
+ (e) => {
+ debugAdapterLogWriter.write("Socket ERROR: " + e + "\r\n")
+ debugAdapterLogWriter.close();
+ debugServiceSocket.destroy();
  process.exit(0);
- }, 1000);
+ });
+
+ // Route any output from the socket through stdout
+ debugServiceSocket.on(
+ 'data',
+ (data: Buffer) => process.stdout.write(data));
+
+ // Wait for the connection to complete
+ debugServiceSocket.on(
+ 'connect',
+ () => {
+ isConnected = true;
+ debugAdapterLogWriter.write("Connected to socket!\r\n\r\n");
+
+ // When data comes on stdin, route it through the socket
+ process.stdin.on(
+ 'data',
+ (data: Buffer) => debugServiceSocket.write(data));
+
+ // Resume the stdin stream
+ process.stdin.resume();
+ });
+
+ // When the socket closes, end the session
+ debugServiceSocket.on(
+ 'close',
+ () => {
+ debugAdapterLogWriter.write("Socket closed, shutting down.");
+ debugAdapterLogWriter.close();
+ isConnected = false;
+
+ // Close after a short delay to give the client time
+ // to finish up
+ setTimeout(() => {
+ process.exit(0);
+ }, 2000);
+ }
+ )
+
+ process.on(
+ 'exit',
+ (e) => {
+ if (debugAdapterLogWriter) {
+ debugAdapterLogWriter.write("Debug adapter process is exiting...");
+ }
+ }
+ )
+}
+
+var sessionFilePath = utils.getSessionFilePath();
+function waitForSessionFile(triesRemaining: number) {
+
+ debugAdapterLogWriter.write(`Waiting for session file, tries remaining: ${triesRemaining}...\r\n`);
+
+ if (triesRemaining > 0) {
+ if (utils.checkIfFileExists(sessionFilePath)) {
+ debugAdapterLogWriter.write(`Session file present, connecting to debug adapter...\r\n\r\n`);
+ startDebugging();
+ }
+ else {
+ // Wait for a second and try again
+ setTimeout(
+ () => waitForSessionFile(triesRemaining - 1),
+ 1000);
+ }
+ }
+ else {
+ debugAdapterLogWriter.write(`Timed out waiting for session file!\r\n`);
+ var errorJson =
+ JSON.stringify({
+ type: "response",
+ request_seq: 1,
+ command: "initialize",
+ success: false,
+ message: "Timed out waiting for the PowerShell extension to start."
+ });
+
+ process.stdout.write(
+ `Content-Length: ${Buffer.byteLength(errorJson, 'utf8')}\r\n\r\n${errorJson}`,
+ 'utf8');
  }
-)
+}
+
+// Wait for the session file to appear
+waitForSessionFile(30);