[vscode] API evolution (public and proposed) and menu declarations between 1.92 and 1.93 (WIP - 1.93 not yet released)

[rschnekenbu]

Sources

• commit ref for tags

  • 1.92.0: b1c0a14
  • 1.93 (as of today): b58b045

• command used

  • git difftool -d b1c0a14..b58b045 -- src/vscode-dts/ on vscode repo
  • command: git submodule foreach "grep -irn enabledApiProposals --include=package.json | cut -d ':' -f 1 | xargs jq --raw-output '{filename: input_filename, enabledApiProposals: .enabledApiProposals}'" > ./vscode-builtins-enabled-proposals-1.93.0.txt on vscode-builtin-extensions repo, on commit b58b045
  • git difftool -d b1c0a14..b58b045 -- src/vs/workbench/services/actions/common/menusExtensionPoint.ts on vscode repo

Evaluation

vscode.d.ts

• TerminalShellIntegration becomes a public API
  • see https://code.visualstudio.com/docs/terminal/shell-integration for the description of the feature.
    Visual Studio Code has the ability to integrate with common shells, allowing the terminal to understand more about what's actually happening inside the shell. This additional information enables some useful features such as [working directory detection](https://code.visualstudio.com/docs/terminal/shell-integration#_current-working-directory-detection) and command detection, [decorations](https://code.visualstudio.com/docs/terminal/shell-integration#_command-decorations-and-the-overview-ruler), and [navigation](https://code.visualstudio.com/docs/terminal/shell-integration#_command-navigation).
  • this API was already available as a proposed API and stubbed as a fix of [VSCode] Support proposed.terminalShellIntegration API #14010
  • Task to be created to move stubs to main and create Implementation task
• API Description evolution
  • **chore task to update code comments (avoid too many differences with vscode.d.ts to facilitate comparison) **
• TreeView reveal options fields become readonly
  • task to update API and check implementation is still valid
• AuthenticationSessionAccountInformation and multiple accounts support additions
  • allow to work with multiple account and get AuthentificationSession from one of them
  • see https://github.com/microsoft/vscode-docs/blob/vnext/release-notes/v1_93.md#authentication-account-api
  • Task to implement such feature
• TestMessageStackFrame addition
  • A stack frame found in the TestMessage.stackTrace
  • create task to add such feature

Proposed API evolutions

• vscode.proposed.aiTextSearchProviderNew.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.authGetSessions.d.ts: Deleted - builtins impacted: Not used by builtins.
• vscode.proposed.chatParticipantAdditions.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.chatParticipantPrivate.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.chatProvider.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.chatVariableResolver.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.contribChatParticipantDetection.d.ts: Renamed - builtins impacted: Not used by builtins.
• vscode.proposed.contribDebugCreateConfiguration.d.ts: New - builtins impacted: Not used by builtins.
• vscode.proposed.contribSourceControlHistoryItemChangesMenu.d.ts: Deleted - builtins impacted: Git.
• vscode.proposed.contribSourceControlHistoryItemGroupMenu.d.ts: Deleted - builtins impacted: Git.
• vscode.proposed.contribSourceControlHistoryItemMenu.d.ts: Updated - builtins impacted: Git.
• vscode.proposed.contribSourceControlHistoryTitleMenu.d.ts: New - builtins impacted: Git.
• vscode.proposed.contribViewContainerTitle.d.ts: New - builtins impacted: Not used by builtins.
• vscode.proposed.defaultChatParticipant.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.extensionsAny.d.ts: Updated - builtins impacted: extensionsAny.
• vscode.proposed.fileSearchProviderNew.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.findFiles2New.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.findTextInFilesNew.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.interactive.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.lmTools.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.notebookReplDocument.d.ts: New - builtins impacted: Not used by builtins.
• vscode.proposed.scmHistoryProvider.d.ts: Updated - builtins impacted: Git.
• vscode.proposed.terminalShellIntegration.d.ts: Deleted, integrated as public API - builtins impacted: Not used by builtins.
• vscode.proposed.testMessageStackTrace.d.ts: Deleted, integrated as public API - builtins impacted: Not used by builtins.
• vscode.proposed.testObserver.d.ts: Updated - builtins impacted: vscode-selfhost-testObserver, can be ignored.
• vscode.proposed.textSearchCompleteNew.d.ts: Updated - builtins impacted: Not used by builtins.
• vscode.proposed.textSearchProviderNew.d.ts: Updated - builtins impacted: Not used by builtins.

Details on scmHistoryProvider evolutions:

• provideHistoryItems: Updated - The method signature was modified by removing the historyItemGroupId parameter from provideHistoryItems and provideHistoryItems2, consolidating them into a single method provideHistoryItems(options: SourceControlHistoryOptions, token: CancellationToken): ProviderResult<SourceControlHistoryItem[]>.
• resolveHistoryItemGroupCommonAncestor: Updated - The two separate methods resolveHistoryItemGroupCommonAncestor and resolveHistoryItemGroupCommonAncestor2 were consolidated into one method resolveHistoryItemGroupCommonAncestor(historyItemGroupIds: string[], token: CancellationToken): ProviderResult<string>.
• SourceControlHistoryOptions: Updated - Added a new property skip?: number to the SourceControlHistoryOptions interface.
• SourceControlHistoryItem: Updated - Added a new optional property displayId?: string to the SourceControlHistoryItem interface.

Details on extensionsAny.d.ts:

• getExtension: Updated - Added a new overload for the getExtension function with the signature getExtension<T = any>(extensionId: string, includeDifferentExtensionHosts: true): Extension<T | undefined> | undefined.

Menu evolutions

To be finalized later

[rschnekenbu]

closed as documentation task. Menu evolutions done on #14106