🚀 在 VS Code 中免费获取

扩展指南

在 Hello World 示例中学习了 Visual Studio Code 扩展 API 的基础知识后,现在是构建一些实际扩展的时候了。 尽管“扩展功能”部分概述了扩展可以执行哪些高级操作,但本节包含详细的代码指南和示例列表,说明了如何使用特定的 VS Code API。

在每个指南或示例中,您可以找到

  • 带有详细注释的源代码。
  • 显示示例扩展用法的 GIF 或图像。
  • 运行示例扩展的说明。
  • 正在使用的 VS Code API 列表。
  • 正在使用的贡献点列表。
  • 类似于示例的实际扩展。
  • API 概念的解释。

指南和示例

以下是 VS Code 网站上的指南,包括它们对 VS Code API 和贡献点的使用。 不要忘记参考 UX 指南,了解创建扩展的用户界面最佳实践。

VS Code 网站上的指南 API 和贡献
命令 commands
contributes.commands
颜色主题 contributes.themes
文件图标主题 contributes.iconThemes
产品图标主题 contributes.productIconThemes
树视图 window.createTreeView
window.registerTreeDataProvider
树视图
TreeDataProvider
contributes.views
contributes.viewsContainers
Webview window.createWebviewPanel
window.registerWebviewPanelSerializer
自定义编辑器 window.registerCustomEditorProvider
CustomTextEditorProvider
contributes.customEditors
虚拟文档 workspace.registerTextDocumentContentProvider
commands.registerCommand
window.showInputBox
虚拟工作区 workspace.fs
capabilities.virtualWorkspaces
工作区信任 workspace.isTrusted
workspace.onDidGrantWorkspaceTrust
capabilities.untrustedWorkspaces
任务提供程序 tasks.registerTaskProvider
任务
ShellExecution
contributes.taskDefinitions
源代码管理 workspace.workspaceFolders
源代码管理
SourceControlResourceGroup
scm.createSourceControl
TextDocumentContentProvider
contributes.menus
调试器扩展 contributes.breakpoints
contributes.debuggers
调试
Markdown 扩展 markdown.previewStyles
markdown.markdownItPlugins
markdown.previewScripts
测试扩展 TestController
TestItem
自定义数据扩展 contributes.html.customData
contributes.css.customData

以下是来自 VS Code 扩展示例仓库的其他示例列表。

GitHub 仓库上的示例 API 和贡献
Webview 示例 window.createWebviewPanel
window.registerWebviewPanelSerializer
状态栏示例 window.createStatusBarItem
StatusBarItem
树视图示例 window.createTreeView
window.registerTreeDataProvider
树视图
TreeDataProvider
contributes.views
contributes.viewsContainers
任务提供程序示例 tasks.registerTaskProvider
任务
ShellExecution
contributes.taskDefinitions
多根示例 workspace.getWorkspaceFolder
workspace.onDidChangeWorkspaceFolders
完成提供程序示例 languages.registerCompletionItemProvider
CompletionItem
SnippetString
文件系统提供程序示例 workspace.registerFileSystemProvider
编辑器装饰器示例 TextEditor.setDecorations
DecorationOptions
DecorationInstanceRenderOptions
ThemableDecorationInstanceRenderOptions
window.createTextEditorDecorationType
TextEditorDecorationType
contributes.colors
L10N 示例
终端示例 window.createTerminal
window.onDidChangeActiveTerminal
window.onDidCloseTerminal
window.onDidOpenTerminal
window.Terminal
window.terminals
Vim 示例 commands
StatusBarItem
window.createStatusBarItem
TextEditorCursorStyle
window.activeTextEditor
Position
Range
Selection
TextEditor
TextEditorRevealType
TextDocument
源代码管理示例 workspace.workspaceFolders
源代码管理
SourceControlResourceGroup
scm.createSourceControl
TextDocumentContentProvider
contributes.menus
注释 API 示例
文档编辑示例 commands
contributes.commands
入门示例 contributes.walkthroughs
测试扩展 TestController
TestItem

语言扩展示例

这些示例是语言扩展示例

示例 VS Code 网站上的指南
代码片段示例 /api/language-extensions/snippet-guide
语言配置示例 /api/language-extensions/language-configuration-guide
LSP 示例 /api/language-extensions/language-server-extension-guide
LSP 日志流示例 N/A
LSP 多根服务器示例 https://github.com/microsoft/vscode/wiki/Adopting-Multi-Root-Workspace-APIs#language-client--language-server (GitHub 仓库 Wiki)
LSP Web 扩展示例 /api/language-extensions/language-server-extension-guide