PowerShell / PowerShell/vscode-powershell
Implement HelpMessage in the interactive console
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.9k
- Forks
- 547
- PR merge metrics
- No merged PRs in 30d
Description
(Should be a PowerShellEditorServices issue, but here for visibility)
Moved from https://github.com/Microsoft/vscode/issues/59042.
The ReadLine of the custom host does not support the HelpMessage parameter setting:
function Test-ParametersAndPrompts {
[cmdletbinding()]
param(
[parameter(Mandatory, HelpMessage = 'Enter the location of the folder.')]
[string]
$Path
)
process {
$path
}
}
Running Test-ParametersAndPrompts in the Integrated Console correctly prompts for the Path parameter, but does not support the ?! input to get the help message.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the custom host ReadLine implementation and reproduce the example in the Integrated Console. Trace how mandatory parameter prompts handle input, especially the ?! response. Done means a HelpMessage such as “Enter the location of the folder.” is shown when ?! is entered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, typescript
- Domain
- cli, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100