VS Code插件开发教程（4） 插件指南 Extension Guidesd

介绍

之前在 VS Code插件开发笔记（2） Get Started 的Hello World示例中学到了一些Visual Studio Code插件API的基本用法，现在是时候更进一步，学习创建一些更加实用的插件了。在之前的文章 VS Code插件开发笔记（3） Capabilities 我们概括性的介绍了一个插件可以做些什么，从本文开始我们将会逐步详细展开，用一系列指南（guides）和代码示例来介绍具体的VS Code API用法

在每篇指南（guides）和示例代码中，我们将提供一下内容：

• 针对源代码的完整注释
• 以gif或静态图的方式提供示例插件的使用方法
• 示例插件的运行说明
• 用到的VS Code API列表
• 用到的Contribution Points列表
• 真实插件和示例之间的关系
• 对 API 概念的解释

一般插件指南&示例

后续我们会介绍一系列的开发指南和示例，包含VS Code API和Contribution Points的用法，下面我们以列表的形式将这些指南和示例罗列出来：

指南

指南	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
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
Custom Data Extension	contributes.html.customData contributes.css.customData

示例

示例的源代码参见 示例插件代码仓库

示例	API & Contribution
Webview Sample	window.createWebviewPanel window.registerWebviewPanelSerializer
Status Bar Sample	window.createStatusBarItem StatusBarItem
Tree View Sample	window.createTreeView window.registerTreeDataProvider TreeView TreeDataProvider contributes.views contributes.viewsContainers
Task Provider Sample	tasks.registerTaskProvider Task ShellExecution contributes.taskDefinitions
Multi Root Sample	workspace.getWorkspaceFolder workspace.onDidChangeWorkspaceFolders
Completion Provider Sample	languages.registerCompletionItemProvider CompletionItem SnippetString
File System Provider Sample	workspace.registerFileSystemProvider
Editor Decoractor Sample	TextEditor.setDecorations DecorationOptions DecorationInstanceRenderOptions ThemableDecorationInstanceRenderOptions window.createTextEditorDecorationType TextEditorDecorationType contributes.colors
I18n Sample	-
Terminal Sample	window.createTerminal window.onDidChangeActiveTerminal window.onDidCloseTerminal window.onDidOpenTerminal window.Terminal window.terminals
Vim Sample	commands StatusBarItem window.createStatusBarItem TextEditorCursorStyle window.activeTextEditor Position Range Selection TextEditor TextEditorRevealType TextDocument
Source Control Sample	workspace.workspaceFolders SourceControl SourceControlResourceGroup scm.createSourceControl TextDocumentContentProvider contributes.menus
Commenting API Sample	-
Document Editing Sample	commands

语言插件示例

示例	指南
Snippet Sample	[Snippet Guide]
Language Configuration Sample	[Language Configuration Guide]
LSP Sample	[Language Server Extension Guide]
LSP Log Streaming Sample	-
LSP Multi Root Server Sample	language-client--language-server

相关文章

• VS Code插件开发教程（1） Overview

• VS Code插件开发教程（2） 起步 Get Started

• VS Code插件开发教程（3） 插件能力一览 Capabilities

• VS Code插件开发教程（4） 插件指南 Extension Guidesd

• VS Code插件开发教程（5） 命令的使用 Command

• VS Code插件开发教程（6） 颜色主题一览 Color Theme

• VS Code插件开发教程（7） 树视图 Tree View

• VS Code插件开发教程（8） Webview

• VS Code插件开发教程（9）构建自定义编辑器 Custom Editor

• VS Code插件开发教程（10）编程式语言特性 Programmatic Language Features

• VS Code插件开发教程（11）语言服务器入门 Language Server Extension Guide