Skip to content

Change Get-Help behavior to return local help when no online help available #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Sep 21, 2018
Merged

Change Get-Help behavior to return local help when no online help available #721

Changes from 10 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c35d13e
Change from Online to Full
corbob Jul 12, 2018
75f8afb
Added checking for RelatedLinks
corbob Aug 10, 2018
55936d1
Check if command first
corbob Aug 10, 2018
6ad4e91
Cleanup types. Output when no commands found.
corbob Aug 18, 2018
51a2ae8
Refactor to a PowerShell Function
corbob Sep 3, 2018
0f65dc6
Remove extraneous function declaration.
corbob Sep 5, 2018
74f04ff
Move Script to private static variable
corbob Sep 5, 2018
c772aa0
Be explicit with bool parameters
corbob Sep 6, 2018
4090e8e
Chain all the things (checkHelpPSCommand variable)
corbob Sep 6, 2018
c481d02
minor bug fix
corbob Sep 6, 2018
d125d66
Handle both powerShell/showOnlineHelp and powerShell/showHelp
corbob Sep 16, 2018
f100131
Try -> try
corbob Sep 16, 2018
c2ba5ad
Remove Online from filename
corbob Sep 19, 2018
504a5a8
Tidy up. Resolve comments from PR.
corbob Sep 19, 2018
004d53d
Fix Typo. Adjust whitespace.
corbob Sep 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,21 @@ namespace Microsoft.PowerShell.EditorServices.Protocol.Server
{
public class LanguageServer
{
private const string CheckHelpScript = @"
[CmdletBinding()]
param (
[String]$CommandName
)
Try {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Below you use a lower case try (and everywhere else uses lower case keywords). Probably should tweak that here to be consistent. :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll get this corrected after the below comment is replied to so I'm not doing a bunch of extra work :)

$null = Microsoft.PowerShell.Core\Get-Command $CommandName -ErrorAction Stop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 for module prefixed commands!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this script is only used in the HandleShowOnlineHelpRequest method, then it should be moved inside that method as a const string.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to make sense. As was said in slack: if it's a const string it won't be stack alloc'd each time the methos is invoked. https://stackoverflow.com/questions/7616448/const-string-inside-a-function

Unless @tylerl0706 @SeeminglyScience or @rjmholt have any objections I'll move the string back into the function as const...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reasonable to me! Let's hear what 1 other has to say

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep no issues with that 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the string into the function as const

(also creeped the scope a bit by handling both commands that could come in (although not from vscode-powershell...) and marking one as deprecated.

} catch [System.Management.Automation.CommandNotFoundException] {
$PSCmdlet.ThrowTerminatingError($PSItem)
}
try {
$null = Microsoft.PowerShell.Core\Get-Help $CommandName -Online
} catch [System.Management.Automation.PSInvalidOperationException] {
Microsoft.PowerShell.Core\Get-Help $CommandName -Full
}";
private static CancellationTokenSource existingRequestCancellation;

private ILogger Logger;
Expand Down Expand Up @@ -230,20 +245,16 @@ await requestContext.SendResult(
}
});
}

protected async Task HandleShowOnlineHelpRequest(
string helpParams,
RequestContext<object> requestContext)
{
if (helpParams == null) { helpParams = "get-help"; }

var psCommand = new PSCommand();
psCommand.AddCommand("Get-Help");
psCommand.AddArgument(helpParams);
psCommand.AddParameter("Online");

await editorSession.PowerShellContext.ExecuteCommand<object>(psCommand);
if (string.IsNullOrEmpty(helpParams)) { helpParams = "Get-Help"; }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a newline above this if


PSCommand checkHelpPSCommand = new PSCommand()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was about to complain about the lack of var here, but technically the type here is the return type of the method. So all I feel is ambivalence.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used PSCommand due to all the other comments about being explicit about the variable type 😁

Copy link
Contributor

@rjmholt rjmholt Sep 6, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wholly agree. In general you wouldn't lose explicit variable type constraints with var when the constructor is on the RHS of the assignment (var x = new Banana();), but here it's more nuanced because of a sort of Builder pattern scenario...

.AddScript(CheckHelpScript, useLocalScope: true)
.AddArgument(helpParams);
await editorSession.PowerShellContext.ExecuteCommand<PSObject>(checkHelpPSCommand, sendOutputToHost: true);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a newline above the first await statement

await requestContext.SendResult(null);
}

Expand Down