ist jetzt verfügbar! Lesen Sie über die neuen Funktionen und Fehlerbehebungen vom November.

Erweiterungsleitfäden

Nachdem Sie die Grundlagen der Visual Studio Code Extension API im Hello World-Beispiel gelernt haben, ist es an der Zeit, einige reale Erweiterungen zu erstellen. Während der Abschnitt Extension Capabilities High-Level-Übersichten darüber bietet, was eine Erweiterung tun kann, enthält dieser Abschnitt eine Liste detaillierter Code-Anleitungen und Beispiele, die erklären, wie eine bestimmte VS Code API verwendet wird.

In jeder Anleitung oder jedem Beispiel können Sie Folgendes erwarten:

  • Ausführlich kommentierter Quellcode.
  • Ein GIF oder Bild, das die Verwendung des Beispiel-Extensions zeigt.
  • Anweisungen zum Ausführen der Beispiel-Extensions.
  • Auflistung der verwendeten VS Code API.
  • Auflistung der verwendeten Contribution Points.
  • Reale Erweiterungen, die dem Beispiel ähneln.
  • Erklärung von API-Konzepten.

Anleitungen & Beispiele

Hier sind die Anleitungen auf der VS Code-Website, einschließlich ihrer Verwendung der VS Code API und der Contribution Points. Vergessen Sie nicht, die UX Guidelines zu beachten, um die Best Practices für die Benutzeroberfläche bei der Erstellung von Erweiterungen zu erlernen.

Anleitung auf der VS Code-Website API & Contribution
Befehl Befehle
contributes.commands
Farbschema contributes.themes
Dateisymbol-Schema contributes.iconThemes
Produkt-Symbol-Schema contributes.productIconThemes
Baumansicht window.createTreeView
window.registerTreeDataProvider
TreeView
TreeDataProvider
contributes.views
contributes.viewsContainers
Webview window.createWebviewPanel
window.registerWebviewPanelSerializer
Benutzerdefinierte Editoren window.registerCustomEditorProvider
CustomTextEditorProvider
contributes.customEditors
Virtuelle Dokumente workspace.registerTextDocumentContentProvider
commands.registerCommand
window.showInputBox
Virtuelle Arbeitsbereiche workspace.fs
capabilities.virtualWorkspaces
Vertrauen in Arbeitsbereiche workspace.isTrusted
workspace.onDidGrantWorkspaceTrust
capabilities.untrustedWorkspaces
Aufgabenanbieter tasks.registerTaskProvider
Task
ShellExecution
contributes.taskDefinitions
Quellcodeverwaltung workspace.workspaceFolders
SourceControl
SourceControlResourceGroup
scm.createSourceControl
TextDocumentContentProvider
contributes.menus
Debugger-Erweiterung contributes.breakpoints
contributes.debuggers
debug
Markdown-Erweiterung markdown.previewStyles
markdown.markdownItPlugins
markdown.previewScripts
Test-Erweiterung TestController
TestItem
Benutzerdefinierte Datenerweiterung contributes.html.customData
contributes.css.customData

Hier ist eine Liste zusätzlicher Beispiele aus dem VS Code Extensions Samples Repo.

Beispiel im GitHub Repo API & Contribution
Webview-Beispiel window.createWebviewPanel
window.registerWebviewPanelSerializer
Statusleisten-Beispiel window.createStatusBarItem
StatusBarItem
Baumansicht-Beispiel window.createTreeView
window.registerTreeDataProvider
TreeView
TreeDataProvider
contributes.views
contributes.viewsContainers
Task-Provider-Beispiel tasks.registerTaskProvider
Task
ShellExecution
contributes.taskDefinitions
Multi-Root-Beispiel workspace.getWorkspaceFolder
workspace.onDidChangeWorkspaceFolders
Vervollständigungs-Provider-Beispiel languages.registerCompletionItemProvider
CompletionItem
SnippetString
Dateisystem-Provider-Beispiel workspace.registerFileSystemProvider
Editor-Dekorations-Beispiel TextEditor.setDecorations
DecorationOptions
DecorationInstanceRenderOptions
ThemableDecorationInstanceRenderOptions
window.createTextEditorDecorationType
TextEditorDecorationType
contributes.colors
L10N-Beispiel
Terminal-Beispiel window.createTerminal
window.onDidChangeActiveTerminal
window.onDidCloseTerminal
window.onDidOpenTerminal
window.Terminal
window.terminals
Vim-Beispiel Befehle
StatusBarItem
window.createStatusBarItem
TextEditorCursorStyle
window.activeTextEditor
Position
Range
Selection
TextEditor
TextEditorRevealType
TextDocument
Source-Control-Beispiel workspace.workspaceFolders
SourceControl
SourceControlResourceGroup
scm.createSourceControl
TextDocumentContentProvider
contributes.menus
Kommentar-API-Beispiel
Dokumentbearbeitungs-Beispiel Befehle
contributes.commands
Erste Schritte-Beispiel contributes.walkthroughs
Test-Erweiterung TestController
TestItem

Spracherweiterungs-Beispiele

Diese Beispiele sind Beispiele für Spracherweiterungen.

Beispiel Anleitung auf der VS Code-Website
Snippet-Beispiel /api/language-extensions/snippet-guide
Sprachkonfigurations-Beispiel /api/language-extensions/language-configuration-guide
LSP-Beispiel /api/language-extensions/language-server-extension-guide
LSP-Protokoll-Streaming-Beispiel N/A
LSP Multi-Root-Server-Beispiel https://github.com/microsoft/vscode/wiki/Adopting-Multi-Root-Workspace-APIs#language-client--language-server (GitHub Repo Wiki)
LSP Web-Erweiterungs-Beispiel /api/language-extensions/language-server-extension-guide
© . This site is unofficial and not affiliated with Microsoft.