Implements a starting tab reading API #131998
Conversation
src/vs/vscode.proposed.d.ts
Outdated
| * An {@link Event} which fires when the array of {@link window.tabs tabs} | ||
| * has changed. | ||
| */ | ||
| export const onDidChangeTabs: Event<ReadonlyArray<Tab>>; |
There was a problem hiding this comment.
readonly Tab[] and consider an event which contains added, changed, removed tabs, similar to WorkspaceFoldersChangeEvent
There was a problem hiding this comment.
I wonder the usefulness of that. I was just going off the onDidChangeVisibleTextEditors which returns the text editors array.
There was a problem hiding this comment.
It will likely help you manage diagnostics, eg. remove diagnostics for closed tab. Have this information in the event means user don't need to iterate over the array all the time. Tho, this is P2 and not blocking merging this
There was a problem hiding this comment.
I feel like if we were to add this we would definitely want to add an order as then it would be a lot harder to discern where these tabs were located
There was a problem hiding this comment.
You need to explain why that motivates order and what order-value closed tabs should have?
There was a problem hiding this comment.
For example a rename is basically just an open and close of a tab in the same location. It also could be interesting to know what tab now possesses the location of the previously closed tab. The order value would just be the index it had in the group. So it would be something like [{order: 0, viewColumn: 1}, {order: 1, viewColumn: 1}, {order: 0, viewColumn: 2}, {order: 1, viewColumn: 2}]
Additionally I either think we would want to have Added, Changed, Removed on the onDidChange or break up the events. onDidChange would just be the list, then onDidAdd, onDidRemove, onDidMove, onDidRename etc because there's a lot more than adding and removing a tab
There was a problem hiding this comment.
So, you do agree that having knowledge about closed tabs is useful (sample here) but you couple its value to an order attribute? I think that is just artificial complexity and I wanna see a real world use-case
There was a problem hiding this comment.
I'm not sure of a use case off the top of my head by I know added / removed is a common API pattern and I value the consistency. I will bring it up as a discussion for the API sync and we can discuss there. I'm going to merge this since this is first major chunk of the API and another PR will be used for adjustments
|
@lramos15 I forgot to mention this in my review: can we please also have integration tests for this new API, should be quite easy to cover, even including custom editors and/or notebooks or even diffs. |
|
code pointer: extensions/vscode-api-tests/src/singlefolder-tests/window.test.ts |
This PR is part of ##15178
Initial work for a tab reading API. Hoping to get some feedback and it merged in so I can test with proposed API