Skip to content

[vscode] API evolution (public and proposed) and menu declarations between 1.95 and 1.96 - WIP #14572

@rschnekenbu

Description

@rschnekenbu

Sources

  • commit ref for tags

  • 1.95.1: 65edc49

  • 1.96.0-master: 3920366

  • command used

  • git difftool -d 65edc49..3920366 -- 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.96.0-master.txt on vscode-builtin-extensions repo, on commit 3920366

  • git difftool -d 65edc49..3920366 -- src/vs/workbench/services/actions/common/menusExtensionPoint.ts on vscode repo

Evaluation

vscode.d.ts

  • IconPath as a new type, reused in various places (e.g. QuickPickItem, WorkspaceEditEntryMetadata, TreeItem, TerminalOptions, ExtensionTerminalOption, QuickInputButton, ChatParticipant, ChatResponseStream, ChatResponseReferencePart)
  • CodeActionProvider#provideCodeActions() signature as changed from (Command | T)[] to Array<Command | T>
  • ShelExecution constructor signature from args: (string | ShellQuotedString)[] to args: Array<string | ShellQuotedString>
  • TestRunProfile loadDetailedCoverageForTest() addition, with FileCoverage#includesTests property
  • LanguageModelChatMessage constructor & content from XX[] to Array + static utilities
  • LanguageModelToolResultPart content from XX[] to Array
  • LanguageModelToolResult content from XX[] to Array
  • PreparedToolInvocation invocationMessage now supports also MarkdownString
  • some comments

Proposed API evolutions

  • vscode.proposed.aiTextSearchProvider.d.ts: updated API, not used in builtins
  • vscode.proposed.aiTextSearchProviderNew.d.ts: removed, not used in builtins
  • vscode.proposed.attributableCoverage.d.ts: removed as now public API
  • vscode.proposed.chatEditing.d.ts: new, not used in builtins
  • vscode.proposed.chatParticipantAdditions.d.ts: updated, not used in builtins
  • vscode.proposed.chatProvider.d.ts: updated, not used in builtins
  • vscode.proposed.contribIssueReporter.d.ts: removed as public API, new menu
  • vscode.proposed.documentPaste.d.ts: updated, used in Typescript, Markdown, & CSS. Added static value Text in DocumentDropOrPasteEditKind. See [vscode] documentPaste proposed API evolution with VS Code 1.96 #14603
  • vscode.proposed.fileSearchProvider2.d.ts: renamed from fileSearchProviderNew existing, not used in builtins
  • vscode.proposed.fileSearchProviderNew.d.ts: deleted (as renamed as fileSearchProvider2
  • vscode.proposed.findFiles2.d.ts: updated, only used in test builtins
  • vscode.proposed.findFiles2New.d.ts: deleted
  • vscode.proposed.findTextInFiles2, renamed from vscode.proposed.findTextInFileNew
  • vscode.proposed.inlineEdit.d.ts: updated, not used in builtins
  • vscode.proposed.lmTools.d.ts: deleted (empty)
  • vscode.proposed.mappedEditsProvider.d.ts: updated, used by Typescript - Only Array<> rather than []. Can be done with [vscode] some signature changes from [] to Array<>  #14580
  • vscode.proposed.nativeWindowHandle.d.ts: new, used in microsoft-authentication builtin. Can be ignored for now (see https://github.com/eclipse-theia/vscode-builtin-extensions/blob/6b561aeb7e629a6255f8f7b92e892949e4c0013c/src/package-vsix.js#L46)
  • vscode.proposed.notebookCellExecution.d.ts: updated, not used in builtins
  • vscode.proposed.quickDiffProvider.d.ts: updated, used in Git, added visible optional property. Proposed interface not yet implemented, will be ignored for now.
  • vscode.proposed.terminalCompletionProvider.d.ts: new: used in terminal-suggest. See stub task [vscode] Stub new terminalCompletionProvider proposed API with 1.96 #14604
  • vscode.proposed.textEditorDiffInformation.d.ts: new, used in Git, added a set of new types types**. Probably stub or ignore it in first place.
  • vscode.proposed.textSearchComplete2.d.ts: renamed from vscode.proposed.textSearchCompleteNew.d.ts, not used in builtins
  • vscode.proposed.textSearchProvider2.d.ts, renamed from vscode.proposed.textSearchProviderNew.d.ts, not used in builtins
  • vscode.proposed.valueSelectionInQuickPick.d.ts: new, not used in builtins

Menu evolutions

  • The menu 'issue/reporter' switched from proposed to public.

Metadata

Metadata

Assignees

Labels

vscodeissues related to VSCode compatibility

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions