Skip to content

Show usage (short) help if command line parameter is wrong #5780

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
iSazonov merged 2 commits into from
Jan 5, 2018
Merged

Show usage (short) help if command line parameter is wrong #5780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72fd183
Show short help if command line parameter is wrong
iSazonov Jan 3, 2018
eb1b069
Split Help message on Usage and Extended
iSazonov Jan 4, 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
8 changes: 7 additions & 1 deletion src/Microsoft.PowerShell.ConsoleHost/host/msh/CommandLineParameterParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,10 @@ private void ShowHelp()
Dbg.Assert(_helpText != null, "_helpText should not be null");
_hostUI.WriteLine("");
_hostUI.Write(_helpText);
if (_showExtendedHelp)
{
_hostUI.Write(ManagedEntranceStrings.ExtendedHelp);
Copy link
Member

@SteveL-MSFT SteveL-MSFT Jan 4, 2018

Choose a reason for hiding this comment

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

Shouldn't this show both UsageHelp and ExtendedHelp?

Copy link
Collaborator Author

@iSazonov iSazonov Jan 4, 2018

Choose a reason for hiding this comment

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

Line 396 already show UsageHelp.

Copy link
Member

@SteveL-MSFT SteveL-MSFT Jan 4, 2018

Choose a reason for hiding this comment

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

Got it!

}
_hostUI.WriteLine("");
}

Expand Down Expand Up @@ -536,6 +540,7 @@ private void ParseHelper(string[] args)
else if (MatchSwitch(switchKey, "help", "h") || MatchSwitch(switchKey, "?", "?"))
{
_showHelp = true;
_showExtendedHelp = true;
_abortStartup = true;
}
else if (MatchSwitch(switchKey, "noexit", "noe"))
Expand Down Expand Up @@ -955,7 +960,7 @@ bool TryGetBoolValue(string arg, out bool boolValue)
}
WriteCommandLineError(
string.Format(CultureInfo.CurrentCulture, CommandLineParameterParserStrings.ArgumentFileDoesNotExist, args[i]),
showBanner: false);
showHelp: true);
return false;
}

Expand Down Expand Up @@ -1164,6 +1169,7 @@ private bool CollectArgs(string[] args, ref int i)
private string _configurationName;
private PSHostUserInterface _hostUI;
private bool _showHelp;
private bool _showExtendedHelp;
private bool _showBanner = true;
private bool _noInteractive;
private string _bannerText;
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.PowerShell.ConsoleHost/host/msh/ManagedEntrance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public static int Start(string consoleFilePath, [MarshalAs(UnmanagedType.LPArray
var formattedBanner = string.Format(CultureInfo.InvariantCulture, banner, PSVersionInfo.GitCommitId);
exitCode = Microsoft.PowerShell.ConsoleShell.Start(
formattedBanner,
ManagedEntranceStrings.ShellHelp,
ManagedEntranceStrings.UsageHelp,
args);
}
catch (System.Management.Automation.Host.HostException e)
Expand Down
7 changes: 5 additions & 2 deletions src/Microsoft.PowerShell.ConsoleHost/resources/ManagedEntranceStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Copyright (c) Microsoft Corporation. All rights reserved.
https://aka.ms/pscore6-docs
Type 'help' to get help.</value>
</data>
<data name="ShellHelp" xml:space="preserve">
<data name="UsageHelp" xml:space="preserve">
<value>Usage: pwsh[.exe] [[-File] &lt;filePath&gt; [args]]
[-Command { - | &lt;script-block&gt; [-args &lt;arg-array&gt;]
| &lt;string&gt; [&lt;CommandParameters&gt;] } ]
Expand All @@ -137,7 +137,10 @@ Type 'help' to get help.</value>

PowerShell Online Help https://aka.ms/pscore6-docs

All parameters are case-insensitive.
All parameters are case-insensitive.</value>
</data>
<data name="ExtendedHelp" xml:space="preserve">
<value>

-Command | -c
Executes the specified commands (and any parameters) as though they were typed
Expand Down