VIM API Gaps

[egamma]

From @johnfn in #8760

I'm a Vim extension developer and I noticed you guys wanted to know the API gaps. I made an issue for each gap I'm aware of: #2771, #8096, #1431, #8094, #8093, #7177.
#2771 is the highest priority because it can't be worked around.
#8096 is also really important because although it can be worked around, I'm scared of breaking user's history.

The rest would be very nice to have.

Features:

• Need API to for lines visible in viewport #2771 - Cursor movement commands
• API Request: Move Tab #8234 - Active editor movement commands
• Implement Window/Page scroll commands #9609 - Scroll Window/Page commands

Bugs:

• getLinesViewportData api in verticalObjects is returning range where start line and end line is not visible #9542

[kieferrm]

Also includes #9143.

[rebornix]

Short summary of current Vim API gaps:

CJK

it's about #8133.
We had CJK IME issues with VS Code and not enough API exposed for external callers. Alex already fixed those bugs and provided two composing APIs, now CJK should be pefect. What's more, our Integrated Terminal also benefits from it #8892.

Scrolling

it's about #2771, #9143, #9220.
@sandy081 already provided us an API for moving cursors to screen lines/characters and they work great.

1. Move cursor to specific Screen Line or line start, middle or end.
2. Lines in Visible Window. Eg, go to the Nth/Middle line in the window, go to the Nth line from the bottom
3. Screen characters. Scroll screen N characters, it's likely an addition to gm.

Windows and Tabs

1. API Request: Move Tab #8234 and Add commands to move tabs left and right in group #9333 are about moving Tabs to a specific index

Backlog

• [Scrolling] Scroll window / page vertically and horizontally Implement Window/Page scroll commands #9609 @sandy081
• History API Request: Control over history #8096 @alexandrudima
• SelectionChange Reason Add 'Reason' to SelectionChangeEvent #8093 @jrieken
• [Windows and Tabs] Split window horizontally Support to split editors horizontally #1749
• Gutter Gutter customization #9561 or support of relative line numbers directly in Code
• Executed action Reason Support onDidExecuteCommand #1431
• Live position API request: Live Positions #8094 @alexandrudima
• BracketMatching Expose bracket matching functionality to extensions #7177
• [Windows and Tabs] Close a specific indexed Tab Close tab {count} #9677
• [Fold] Manage fold area Feature request: API for managing folding area #9786 @sandy081

[sandy081]

I am removing Scroll Window/Page feature from the current plan. We will take a look at it for next iteration.

[kieferrm]

@sandy081 which issue do you defer?

[kieferrm]

@sandy081: @rebornix and I just ranked the backlog in the comment above to correctly reflect the priorities from the VIM perspective.

[rebornix]

@sandy081 updated my summary and added 4 more separate items. Now they covered all missing features currently on our roadmap, those commands/motions on our roadmap are from Vim's quickref so if there is any missing command that's dependent on VS Code API support but not listed in Vim documentation, I'll update this summary.

[sandy081]

@kieferrm Item I deferred is scrolling window / page feature - #9609

[sandy081]

@rebornix I moved Scrolling and other Tabs items to backlog in above comment. Please arrange them in the order of Vim extension priority.

Thanks.

[rebornix]

Implement all commands that are currently possible with @sandy081 's newly added API. Others are all moved to Backlog section, ordered by priorities.

[egamma]

This work will continue in August - moving the milestone accordingly