如何从零开始开发你自己的第一个VS Code插件-VSCode-PHP中文网

如何从零开始开发你自己的第一个VS Code插件

P粉986688829

发布： 2025-11-29 18:07:42

原创

208人浏览过

答案：开发VS Code插件需先配置Node.js、npm、Yeoman等环境，使用yo code生成TypeScript项目，编写package.json和extension.ts实现命令注册，通过F5调试，最后用vsce打包发布。

如何从零开始开发你自己的第一个vs code插件

想为VS Code开发一个插件，其实没有想象中那么难。只要你熟悉JavaScript或TypeScript，并了解基本的Node.js概念，就可以快速上手。下面带你一步步创建你的第一个VS Code插件。

1. 准备开发环境

在开始之前，确保你已经安装了以下工具：

Node.js（建议使用LTS版本）
npm（Node包管理器，通常随Node.js一起安装）
Visual Studio Code
Yeoman 和 VS Code Extension Generator

安装Yeoman和VS Code插件生成器：

npm install -g yo generator-code

这两个工具能帮你快速搭建插件项目结构。

2. 创建你的第一个插件项目

运行以下命令启动项目生成器：

yo code

你会看到一系列选项，选择“New Extension (TypeScript)”是推荐的起点。然后按提示填写插件名称、标识符、描述等信息。

项目生成后，进入目录并安装依赖：

cd your-extension-name
npm install

接着在VS Code中打开该项目：

code .

3. 理解项目结构和核心文件

新生成的插件项目包含几个关键文件：

package.json：定义插件元信息和激活事件，比如命令触发时机
src/extension.ts：插件主入口，导出 activate 和 deactivate 函数
src/test/runTest.ts（可选）：用于编写测试

重点关注 package.json 中的 contributes 字段，它允许你注册命令、快捷键、菜单等。例如：

Writer

企业级AI内容创作工具

176

查看详情

"contributes": {
"commands": [
{
"command": "hello-world.helloWorld",
"title": "Hello World"
}
]
}

这个命令可以在代码中通过 vscode.commands.registerCommand 注册。

4. 编写和调试插件

打开 extension.ts，你会看到默认的“Hello World”示例。activate 函数在插件激活时执行，你可以在这里注册命令：

export function activate(context: vscode.ExtensionContext) {
const disposable = vscode.commands.registerCommand('hello-world.helloWorld', () => {
vscode.window.showInformationMessage('Hello from my first extension!');
});
context.subscriptions.push(disposable);
}

按下 F5 启动调试，VS Code会打开一个“扩展开发主机”窗口。在那里按下 Ctrl+Shift+P，输入你注册的命令名（如“Hello World”），就能看到弹窗消息。

修改代码后，重启调试即可看到变化。