Skip to content

Fix "Get Help for Command" #4212

Closed
PowerShell/PowerShellEditorServices
#1970
@andyleejordan

Description

@andyleejordan

Prerequisites

  • I have written a descriptive issue title.
  • I have searched all open and closed issues to ensure it has not already been reported.
  • I have read the troubleshooting guide.
  • I am sure this issue is with the extension itself and does not reproduce in a standalone PowerShell instance.
  • I have verified that I am using the latest version of Visual Studio Code and the PowerShell extension.
  • If this is a security issue, I have read the security issue reporting guidance.

Summary

The client command 'Get Help for Command' AKA PowerShell.ShowHelp does not appear to work correctly. The server responds with a URI, which is not shown in the extension terminal, and nothing happens in the client until you hit enter in the terminal, at which point the URI is opened in the browser.

The server's handler script is a bit funky and has a to-do that says "rather than print the help in the console, we should send the string back to VSCode to display in a help pop-up (or similar)." So let's do that!

FWIW PowerShell.OnlineHelp is marked deprecated and at this point should be removed.

PowerShell Version

N/A

Visual Studio Code Version

N/A

Extension Version

N/A

Steps to Reproduce

N/A

Visuals

No response

Logs

No response

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions