`ShowCommandHelp` and `ShowParameterHelp` should support incomplete parameter names (prefixes)

未关闭
#3,560 3 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
48/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
csharp
领域
cli

调研方向

Start by locating the ShowCommandHelp and ShowParameterHelp entry points and reproduce the full-name and prefix examples from the issue. Determine how parameter names are matched, then make unique prefixes work and define the stated behavior for ambiguous prefixes; done means the examples behave as described and the relevant tests pass.

由索引模型根据 Issue 内容生成。

描述

Area-CommandHelp Issue-Enhancement
Prerequisites
  • Write a descriptive title.
Description of the new feature/enhancement

Currently, for said functions to recognize a parameter and jump to the relevant section in the help file / show the parameter type and description below the command line it must be spelled out in full.

# OK, parameter name spelled out in full
Get-Item -LiteralPath<Alt-h>

# !! NO-OP, because the the parameter name is only identified *by prefix*, not spelled out in full.
Get-Item -Lit<Alt-h>

While tab-completing a parameter-name prefix first bypasses the problem, the need to do so is surprising, given that a unique prefix is sufficient for invocation of a command.

If the prefix isn't unique (e.g. Get-ChildItem -F<Alt-h>), I suggest resolving the problem as follows:

  • ShowCommandHelp: jump to the first parameter with the given prefix.
  • ShowParameterHelp: either do nothing, or display a message indicating the ambiguity.
Proposed technical implementation details (optional)

No response

主要语言
C#
星标
4.4k
派生
341
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

PowerShell/PSReadLine 的其他 Issue

查看 PowerShell/PSReadLine 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。