扩展指南
前面在Hello World示例中了解了 Visual Studio Code 扩展 API 的基础知识,可以构建一些实际的扩展了。虽然扩展功能部分提供了扩展功能的高级概述,但本部分包含详细的代码指南和示例列表,解释如何使用特定的 VS Code API。
在每个指南或示例中,您可以找到:
- 彻底注释了源代码。
- 显示示例扩展的用法的 gif 或图像。
- 运行示例扩展的说明。
- 正在使用的 VS Code API 列表。
- 正在使用的贡献点列表。
- 与示例类似的现实世界扩展。
- API 概念的解释。
指南和示例
以下是 VS Code 网站上的指南,包括VS Code API的使用和贡献点。不要忘记参考用户体验指南来了解创建扩展的用户界面最佳实践。
| Guide on VS Code Website | API & Contribution |
|---|---|
| Command | commands |
| Color Theme | contributes.themes |
| File Icon Theme | contributes.iconThemes |
| Product Icon Theme | contributes.productIconThemes |
| Tree View | window.createTreeView、window.registerTreeDataProvider、TreeView、TreeDataProvider、contributes.views、contributes.viewsContainers |
| Webview | window.createWebviewPanel、window.registerWebviewPanelSerializer |
| Custom Editors | window.registerCustomEditorProvider、CustomTextEditorProvider、contributes.customEditors |
| Virtual Documents | workspace.registerTextDocumentContentProvider、commands.registerCommand、window.showInputBox |
| Virtual Workspaces workspace.fs | |
| capabilities.virtualWorkspaces | |
| Workspace Trust workspace.isTrusted | |
| workspace.onDidGrantWorkspaceTrust | |
| capabilities.untrustedWorkspaces | |
| Task Provider tasks.registerTaskProvider | |
| Task | |
| ShellExecution | |
| contributes.taskDefinitions | |
| Source Control workspace.workspaceFolders | |
| SourceControl | |
| SourceControlResourceGroup | |
| scm.createSourceControl | |
| TextDocumentContentProvider | |
| contributes.menus | |
| Debugger Extension contributes.breakpoints | |
| contributes.debuggers | |
| debug | |
| Markdown Extension markdown.previewStyles | |
| markdown.markdownItPlugins | |
| markdown.previewScripts | |
| Test Extension TestController | |
| TestItem | |
| Custom Data Extension contributes.html.customData | |
| contributes.css.customData |
