Microsoft Visual Studio Code 扩展示例项目指南

Microsoft Visual Studio Code 扩展示例项目指南

vscode-extension-samplesSample code illustrating the VS Code extension API.项目地址:https://gitcode.com/gh_mirrors/vs/vscode-extension-samples

目录结构及介绍

在克隆或下载了 microsoft/vscode-extension-samples 仓库之后，您将看到一系列的子目录，每一个都代表了一种不同的扩展样例。以下是一些主要的样本及其说明：

子目录概览

• base-sample: 基础扩展模板。
• authenticationprovider-sample: 认证提供者示例，展示了如何实现自定义身份验证。
• basic-multi-root-sample: 多根工作区支持的基本示例。
• call-hierarchy-sample: 调用层次结构提供器示例，用于展示调用关系。
• chat-sample: 一个聊天扩展的简单实例。
• code-actions-sample: 代码操作示例，演示如何建议并执行编辑操作。
• codelens-sample: CodeLens 提供程序示例。
• comment-sample: 评论API示例。
• completions-sample: 自动补全示例。
• configuration-sample: 配置项示例，演示如何读取和写入设置。
• contentprovider-sample: 内容提供程序示例，用于提供自定义文本视图。
• custom-data-sample: 定制数据存储扩展示例。
• custom-editor-sample: 自定义编辑器示例。
• decorator-sample: 编辑器装饰器示例。

所有这些示例提供了从基本到高级的扩展开发指导，涵盖了VS Code API的不同方面。

启动文件介绍

对于大多数的扩展示例而言，main.js 或 extension.js（取决于语言）是主要的入口点，在这里注册所有的激活事件和贡献点。以 base-sample 为例，其 extension.js 中包含了以下核心部分:

// extension.js 示例
let vscode = require('vscode');
function activate(context) {
	// Register commands, event listeners, etc.
	let disposable = vscode.commands.registerCommand('extension.helloWorld', function () {
		vscode.window.showInformationMessage('Hello World!');
	});
	context.subscriptions.push(disposable);
}

exports.activate = activate;

在这个例子中，我们导入 vscode 模块，定义了一个激活函数 activate() ，并在其中注册了一个命令。这个命令被绑定到 extension.helloWorld 这个ID上，当该命令被调用时，它会在VS Code的消息面板显示一条信息。

记住，实际的启动文件可能因项目而异，但通常它们遵循类似的主题，即定义 activate() 函数来初始化并设置所有的特性。

配置文件介绍

通常，在VS Code扩展中进行配置的主要方式是在 .vscode/launch.json 文件内指定调试配置。此外，package.json 文件是扩展的核心描述性文件之一，它不仅描述了扩展本身的信息，还指定了激活条件以及贡献到VS Code的各种功能，如命令、菜单项等。

例如，考虑 package.json 中的一个片段，它指明了扩展的元信息和激活条件:

{
	"name": "example-extension",
	"displayName": "Example Extension",
	"description": "A simple example VS Code extension.",
	"version": "0.0.1",
	"activationEvents": [
		"*"
	],
	"main": "./out/extension.js",
	"contributes": {
		"commands": [
			{
				"command": "extension.helloWorld",
				"title": "Say Hello World"
			}
		]
	},
	"scripts": {
		"vscode:prepublish": "npm run compile",
		"compile": "tsc -p ./",
		"watch": "tsc -w -p ./"
	},
	"engines": {
		"vscode": "^1.47.0"
	},
	"categories": [
		"Other"
	],
	"dependencies": {
		"vscode": "^1.47.0"
	}
}

上述JSON内容解释了扩展是如何在VS Code环境中识别和启用的。它也指示了编译步骤和其他必要的依赖。通过阅读各个扩展的 package.json 文件，可以了解其具体的功能和配置细节。

vscode-extension-samplesSample code illustrating the VS Code extension API.项目地址:https://gitcode.com/gh_mirrors/vs/vscode-extension-samples