From 135a1621068f2ce3eac93c49df4bb29249bcd401 Mon Sep 17 00:00:00 2001 From: Logan Ramos Date: Tue, 5 Apr 2022 15:06:31 -0400 Subject: [PATCH] Rename .groups to .all again --- .../api/common/extHostDebugService.ts | 2 +- .../workbench/api/common/extHostEditorTabs.ts | 2 +- .../test/browser/extHostEditorTabs.test.ts | 72 +++++++++---------- src/vscode-dts/vscode.proposed.tabs.d.ts | 3 +- 4 files changed, 39 insertions(+), 40 deletions(-) diff --git a/src/vs/workbench/api/common/extHostDebugService.ts b/src/vs/workbench/api/common/extHostDebugService.ts index 228920010ae..1db3ef2485d 100644 --- a/src/vs/workbench/api/common/extHostDebugService.ts +++ b/src/vs/workbench/api/common/extHostDebugService.ts @@ -953,7 +953,7 @@ export class ExtHostVariableResolverService extends AbstractVariableResolverServ if (activeEditor) { return activeEditor.document.uri; } - const activeTab = editorTabs.tabGroups.groups.find(group => group.isActive)?.activeTab; + const activeTab = editorTabs.tabGroups.all.find(group => group.isActive)?.activeTab; if (activeTab !== undefined) { // Resolve a resource from the tab if (activeTab.kind instanceof TextDiffTabInput || activeTab.kind instanceof NotebookDiffEditorTabInput) { diff --git a/src/vs/workbench/api/common/extHostEditorTabs.ts b/src/vs/workbench/api/common/extHostEditorTabs.ts index 1c94af226e1..b699b4c752d 100644 --- a/src/vs/workbench/api/common/extHostEditorTabs.ts +++ b/src/vs/workbench/api/common/extHostEditorTabs.ts @@ -223,7 +223,7 @@ export class ExtHostEditorTabs implements IExtHostEditorTabs { onDidChangeTabGroups: that._onDidChangeTabGroups.event, onDidChangeTabs: that._onDidChangeTabs.event, // dynamic -> getters - get groups() { + get all() { return Object.freeze(that._extHostTabGroups.map(group => group.apiObject)); }, get activeTabGroup() { diff --git a/src/vs/workbench/api/test/browser/extHostEditorTabs.test.ts b/src/vs/workbench/api/test/browser/extHostEditorTabs.test.ts index 8d8f36f9907..67903bab953 100644 --- a/src/vs/workbench/api/test/browser/extHostEditorTabs.test.ts +++ b/src/vs/workbench/api/test/browser/extHostEditorTabs.test.ts @@ -35,7 +35,7 @@ suite('ExtHostEditorTabs', function () { }) ); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 0); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 0); // Active group should never be undefined (there is always an active group). Ensure accessing it undefined throws. // TODO @lramos15 Add a throw on the main side when a model is sent without an active group assert.throws(() => extHostEditorTabs.tabGroups.activeTabGroup); @@ -63,8 +63,8 @@ suite('ExtHostEditorTabs', function () { groupId: 12, tabs: [tab] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - const [first] = extHostEditorTabs.tabGroups.groups; + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + const [first] = extHostEditorTabs.tabGroups.all; assert.ok(first.activeTab); assert.strictEqual(first.tabs.indexOf(first.activeTab), 0); @@ -75,8 +75,8 @@ suite('ExtHostEditorTabs', function () { groupId: 12, tabs: [tab] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - const [first] = extHostEditorTabs.tabGroups.groups; + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + const [first] = extHostEditorTabs.tabGroups.all; assert.ok(first.activeTab); assert.strictEqual(first.tabs.indexOf(first.activeTab), 0); } @@ -95,8 +95,8 @@ suite('ExtHostEditorTabs', function () { groupId: 12, tabs: [] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - const [first] = extHostEditorTabs.tabGroups.groups; + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + const [first] = extHostEditorTabs.tabGroups.all; assert.strictEqual(first.activeTab, undefined); assert.strictEqual(first.tabs.length, 0); }); @@ -121,7 +121,7 @@ suite('ExtHostEditorTabs', function () { }]); assert.ok(extHostEditorTabs.tabGroups.activeTabGroup); const activeTabGroup: vscode.TabGroup = extHostEditorTabs.tabGroups.activeTabGroup; - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); assert.strictEqual(activeTabGroup.tabs.length, 0); assert.strictEqual(count, 1); }); @@ -147,8 +147,8 @@ suite('ExtHostEditorTabs', function () { groupId: 12, tabs: [tab] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - const [first] = extHostEditorTabs.tabGroups.groups; + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + const [first] = extHostEditorTabs.tabGroups.all; assert.ok(first.activeTab); assert.strictEqual(first.tabs.indexOf(first.activeTab), 0); assert.strictEqual(first.activeTab, first.tabs[0]); @@ -172,7 +172,7 @@ suite('ExtHostEditorTabs', function () { groupId: 12, tabs: [tabDto] }]); - let all = extHostEditorTabs.tabGroups.groups.map(group => group.tabs).flat(); + let all = extHostEditorTabs.tabGroups.all.map(group => group.tabs).flat(); assert.strictEqual(all.length, 1); const apiTab1 = all[0]; assert.ok(apiTab1.kind instanceof TextTabInput); @@ -193,7 +193,7 @@ suite('ExtHostEditorTabs', function () { groupId: 12 }); - all = extHostEditorTabs.tabGroups.groups.map(group => group.tabs).flat(); + all = extHostEditorTabs.tabGroups.all.map(group => group.tabs).flat(); assert.strictEqual(all.length, 1); const apiTab2 = all[0]; assert.ok(apiTab1.kind instanceof TextTabInput); @@ -239,7 +239,7 @@ suite('ExtHostEditorTabs', function () { tabs: [tabDtoAAA, tabDtoBBB] }]); - let all = extHostEditorTabs.tabGroups.groups.map(group => group.tabs).flat(); + let all = extHostEditorTabs.tabGroups.all.map(group => group.tabs).flat(); assert.strictEqual(all.length, 2); const activeTab1 = extHostEditorTabs.tabGroups.activeTabGroup?.activeTab; @@ -279,7 +279,7 @@ suite('ExtHostEditorTabs', function () { }); assert.throws(() => { // @ts-expect-error write to readonly prop - extHostEditorTabs.tabGroups.groups.length = 0; + extHostEditorTabs.tabGroups.all.length = 0; }); assert.throws(() => { // @ts-expect-error write to readonly prop @@ -317,7 +317,7 @@ suite('ExtHostEditorTabs', function () { groupId: 12, tabs: [tab] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); const activeTab = extHostEditorTabs.tabGroups.activeTabGroup?.activeTab; assert.ok(activeTab); extHostEditorTabs.tabGroups.close(activeTab, false); @@ -356,10 +356,10 @@ suite('ExtHostEditorTabs', function () { tabs: [tabDto] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 1); - const tab = extHostEditorTabs.tabGroups.groups[0].tabs[0]; + const tab = extHostEditorTabs.tabGroups.all[0].tabs[0]; const p = new Promise(resolve => extHostEditorTabs.tabGroups.onDidChangeTabs(resolve)); @@ -410,8 +410,8 @@ suite('ExtHostEditorTabs', function () { tabs: [tab1, tab2, tab3] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 3); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 3); // Active tab is correct assert.strictEqual(extHostEditorTabs.tabGroups.activeTabGroup?.activeTab, extHostEditorTabs.tabGroups.activeTabGroup?.tabs[0]); @@ -441,8 +441,8 @@ suite('ExtHostEditorTabs', function () { groupId: 12, tabs: [tab3] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 1); assert.strictEqual(extHostEditorTabs.tabGroups.activeTabGroup?.activeTab, extHostEditorTabs.tabGroups.activeTabGroup?.tabs[0]); // Closing out all tabs returns undefine active tab @@ -452,8 +452,8 @@ suite('ExtHostEditorTabs', function () { groupId: 12, tabs: [] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 0); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 0); assert.strictEqual(extHostEditorTabs.tabGroups.activeTabGroup?.activeTab, undefined); }); @@ -489,8 +489,8 @@ suite('ExtHostEditorTabs', function () { tabs: [tab1, tab2, tab3] }]); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 3); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 3); // Close tab 2 extHostEditorTabs.$acceptTabOperation({ @@ -499,8 +499,8 @@ suite('ExtHostEditorTabs', function () { kind: TabModelOperationKind.TAB_CLOSE, tabDto: tab2 }); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 2); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 2); // Close active tab and update tab 3 to be active extHostEditorTabs.$acceptTabOperation({ @@ -509,8 +509,8 @@ suite('ExtHostEditorTabs', function () { kind: TabModelOperationKind.TAB_CLOSE, tabDto: tab1 }); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 1); tab3.isActive = true; extHostEditorTabs.$acceptTabOperation({ groupId: 12, @@ -518,9 +518,9 @@ suite('ExtHostEditorTabs', function () { kind: TabModelOperationKind.TAB_UPDATE, tabDto: tab3 }); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups[0]?.activeTab?.label, 'label3'); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all[0]?.activeTab?.label, 'label3'); // Open tab 2 back extHostEditorTabs.$acceptTabOperation({ @@ -529,8 +529,8 @@ suite('ExtHostEditorTabs', function () { kind: TabModelOperationKind.TAB_OPEN, tabDto: tab2 }); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.length, 1); - assert.strictEqual(extHostEditorTabs.tabGroups.groups.map(g => g.tabs).flat().length, 2); - assert.strictEqual(extHostEditorTabs.tabGroups.groups[0]?.tabs[1]?.label, 'label2'); + assert.strictEqual(extHostEditorTabs.tabGroups.all.length, 1); + assert.strictEqual(extHostEditorTabs.tabGroups.all.map(g => g.tabs).flat().length, 2); + assert.strictEqual(extHostEditorTabs.tabGroups.all[0]?.tabs[1]?.label, 'label2'); }); }); diff --git a/src/vscode-dts/vscode.proposed.tabs.d.ts b/src/vscode-dts/vscode.proposed.tabs.d.ts index b408dd8311f..102c643497e 100644 --- a/src/vscode-dts/vscode.proposed.tabs.d.ts +++ b/src/vscode-dts/vscode.proposed.tabs.d.ts @@ -187,8 +187,7 @@ declare module 'vscode' { /** * All the groups within the group container */ - // TODO@API name, back to `all`, keep xyzTabGroup - readonly groups: readonly TabGroup[]; + readonly all: readonly TabGroup[]; /** * The currently active group