PSReadLine icon indicating copy to clipboard operation
PSReadLine copied to clipboard

Multiple Vi replace methods not public

Open arpan3t opened this issue 2 months ago • 0 comments

Prerequisites

  • [x] Write a descriptive title.
  • [x] Make sure you are able to repro it on the latest released version
  • [x] 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.

arpan3t avatar Oct 23 '25 14:10 arpan3t