Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Multiple Vi replace methods not public

未关闭
#4,984 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

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

调研方向

Read Replace.vi.cs around ViReplaceBrace and ReadLine.vi.cs around ViDeleteBrace, then compare those methods with the about_PSR​​eadLine_functions documentation. Determine whether the documented methods should be public and whether their described behavior matches the implementation; done means the API and documentation discrepancy is resolved.

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

描述

Needs-Triage :mag:
Prerequisites
  • Write a descriptive title.
  • Make sure you are able to repro it on the latest released version
  • Search the existing issues, especially the pinned issues.
Exception report
N/A
Screenshot
Image
Environment data
PS Version: 7.5.3
PS HostName: ConsoleHost (Windows Terminal)
PSReadLine Version: 2.3.6
PSReadLine EditMode: Vi
OS: 10.0.19041.1 (WinBuild.160101.0800)
BufferWidth: 160
BufferHeight: 42
Steps to reproduce
  1. Open console
  2. Try executing [Microsoft.PowerShell.PSConsoleReadLine]::ViReplaceBrace()
Expected behavior

There appears to be multiple PSConsoleReadline methods listed in MS docs that are not actually public class methods. I'm focusing on ViReplaceBrace which is listed as a function in the MS docs to

Replace all characters between the current brace character and it's matching partner.

I guess there's another issue here, in that if the method was made public similar to #581 it wouldn't perform the way that it is documented. Since ViReplaceBrace calls ViDeleteBrace and that

Find the matching brace, parenthesis, or square bracket and delete all contents within, including the brace.

In vim speak that would be in vs. around.

Actual behavior

It looks like the idea behind Replace.vi.cs is to utilize the respective delete function and then change to Vi insert mode. For a lot of these private methods, that works fine and they could be easily made public to align with MS documentation.

If you'd rather I create a PR for MS docs repo to remove these private methods from the list of PSReadline functions, that works too.

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

贡献指南

打开贡献指南

从这里开始

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

PowerShell/PSReadLine 的其他 Issue

查看 PowerShell/PSReadLine 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

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