VSCode扩展开发入门:创建你的第一个Hello World插件

13次阅读

需安装node.js和Yeoman,运行yo code生成typescript扩展模板,在extension.ts中注册extension.helloWorld命令并调用showInformationMessage,配置package.json的contributes和activationEvents,编译后通过Cmd+Shift+P调用命令测试。

VSCode扩展开发入门:创建你的第一个Hello World插件

如果您希望在 visual studio Code 中创建一个简单的扩展来显示“Hello World”消息,则需要了解基本的开发流程和项目结构。以下是实现此目标的具体步骤:

本文运行环境:MacBook Air,macos Sequoia。

一、安装必要工具

开发 vscode 扩展需依赖 Node.js 运行时和 Yeoman 脚手架工具,用于快速生成标准项目模板。确保本地已安装兼容版本的 node.js,并通过 npm 安装 yeoman 和 generator-code。

1、打开终端,执行命令 node –version 验证 Node.js 是否已安装且版本不低于 18.x。

2、运行命令 npm install -g yo generator-code 全局安装 Yeoman 及 VSCode 扩展生成器。

3、确认安装成功,输入 yo –versiongenerator-code –version 查看输出版本号。

二、生成扩展项目骨架

使用 Yeoman 启动交互式向导,自动生成符合 VSCode 扩展规范的初始代码结构,包括 package.json、extension.ts 等核心文件。

1、在终端中执行 yo code 启动向导。

2、选择 New Extension (TypeScript) 选项。

3、依次填写扩展名称(如 hello-world-ext)、标识符(如 helloworldext)、描述、作者等信息,其余选项保持默认。

三、编写激活逻辑与命令注册

VSCode 扩展必须导出 activate 函数,在插件被启用时执行初始化操作。此处需注册一个命令,触发时弹出“Hello World”通知。

1、在生成的 src/extension.ts 文件中,定位到 activate 函数内部。

2、添加语句 vscode.window.showInformationMessage(‘Hello World!’); 作为命令执行体。

3、在 commands.registerCommand 调用中,将命令 ID 设为 extension.helloWorld 并绑定该函数。

四、配置 package.json 中的贡献点

package.json 是扩展的元数据清单,需声明命令、激活事件及权限,使 VSCode 能识别并加载功能。

1、在 contributes 字段下添加 commands 数组,包含 title、command 和 category 属性,其中 command 值为 extension.helloWorld

2、在 activationEvents 数组中加入 onCommand:extension.helloWorld,表示仅在该命令被调用时激活扩展。

3、确认 main 字段指向编译后的入口文件路径,通常为 ./out/extension.js

五、编译并运行调试

TypeScript 代码需编译为 javaScript 才能在 VSCode 中运行。通过内置任务启动扩展开发主机,在隔离环境中测试行为。

1、在 VSCode 中打开项目根目录,按 Cmd+Shift+B(macOS)运行构建任务,生成 out/extension.js。

2、按 Ctrl+Shift+P(macOS 为 Cmd+Shift+P),输入 Developer: Toggle Developer Tools 打开控制台验证无报错。

3、按下 Cmd+Shift+P,输入 Hello World,选择对应命令,观察右下角是否弹出通知。

text=ZqhQzanResources