要创建 VS Code Hello World 插件,需先安装 Node.js、Yeoman 和 TypeScript;再运行 yo code 生成项目;接着在 extension.ts 中注册命令并修改 package.json 声明命令和激活事件;最后通过调试配置运行测试。

如果您希望为 Visual Studio Code 开发一个扩展插件,但尚未配置开发环境或不了解基本项目结构,则可能是由于缺少 Yeoman 生成器、TypeScript 配置或调试启动设置。以下是创建首个 Hello World 插件的步骤:
本文运行环境:MacBook Air,macOS Sequoia。
一、安装必要工具
VSCode 扩展开发依赖 Node.js 运行时与 Yeoman 脚手架工具,还需 TypeScript 编译支持。这些工具共同构成基础开发链路。
1、访问 https://nodejs.org 下载并安装 LTS 版本 Node.js,安装过程将自动包含 npm。
2、在终端中执行 npm install -g yo generator-code 全局安装 Yeoman 及 VS Code 扩展生成器。
3、执行 npm install -g typescript 安装 TypeScript 编译器,确保后续能正确构建 ts 文件。
二、生成扩展项目骨架
使用官方 generator-code 可快速初始化符合 VS Code 扩展规范的 TypeScript 项目,包含 manifest、入口文件及调试配置。
1、在终端中执行 yo code 启动向导。
2、选择 New Extension (TypeScript) 选项。
3、按提示输入扩展名称(如 hello-world-sample)、标识符(默认基于名称生成)、描述等信息。
4、确认生成路径后,等待模板完成初始化,目录中将出现 package.json、extension.ts、tsconfig.json 等核心文件。
三、实现 Hello World 命令逻辑
扩展功能通过注册命令并在用户触发时执行回调函数实现。此处需修改 extension.ts 中的 activate 函数,注入命令注册逻辑。
1、用 VS Code 打开刚生成的项目文件夹。
2、打开 src/extension.ts,定位到 activate 函数内部。
3、在 context.subscriptions.push(...) 之前添加:vscode.commands.registerCommand('extension.sayHello', () => { vscode.window.showInformationMessage('Hello World!'); });
4、确保顶部已导入 vscode 模块:import * as vscode from 'vscode';
四、更新扩展清单配置
package.json 是 VS Code 识别扩展元数据和贡献点的唯一依据,必须声明命令 ID、标题及激活事件,否则命令无法注册。
1、打开项目根目录下的 package.json。
2、在 "contributes" 字段内添加 "commands" 数组,内容为:[{ "command": "extension.sayHello", "title": "Hello World" }]
3、在 "activationEvents" 数组中加入 "onCommand:extension.sayHello",确保插件在命令调用时被激活。
五、运行与调试插件
VS Code 提供内置 Extension Development Host 环境,可实时加载未发布插件并在独立窗口中测试行为。
1、按下 Cmd+Shift+P(macOS)调出命令面板。
2、输入并选择 Tasks: Run Build Task,执行 TypeScript 编译。
3、点击左侧调试图标,选择配置为 Launch Extension,然后点击绿色三角形启动调试。
4、新窗口启动后,再次按下 Cmd+Shift+P,输入 Hello World 并回车,验证弹窗是否显示 Hello World!










