为VS Code开发首个插件需四步:1. 用yo code初始化TypeScript模板;2. 在extension.ts中注册extension.sayHello命令并配置package.json;3. 通过“Developer: Launch Extension”调试并热重载;4. 用vsce打包为.vsix并本地安装。

为 VS Code 开发第一个自定义插件并不难,关键是从最小可行功能起步,理解扩展生命周期和核心 API。下面带你一步步搭起一个能运行、可调试、有实际作用的插件。
1. 初始化插件项目
VS Code 官方推荐使用 yo code 脚手架快速生成模板。先确保已安装 Node.js(≥18.x)和 npm,然后全局安装 Yeoman 和 VS Code 扩展生成器:
- npm install -g yo generator-code
- 运行 yo code,选择 “New Extension (TypeScript)”
- 按提示填写插件名、ID、描述等信息(ID 建议用小写字母+短横线,如 my-first-hello)
生成后会得到一个含 src/extension.ts、package.json 和调试配置的完整项目。
2. 编写最简功能:点击弹出 Hello
打开 src/extension.ts,找到 activate 函数。这是插件被加载时执行的入口。添加一条命令注册:
- 在
activate中调用vscode.commands.registerCommand - 命令 ID 写成 extension.sayHello(需与
package.json中声明一致) - 回调函数里用
vscode.window.showInformationMessage('Hello from my plugin!')
接着打开 package.json,在 contributes.commands 数组中添加对应条目,并确保 activationEvents 包含 onCommand:extension.sayHello,这样插件会在命令触发时自动激活。
SOPHP是一款稳定开源的微信公众平台开发系统,也是基于weiphp开发的第一款商业系统。依托自身强大的钩子功能,她可以帮助大家快速开发出自己想要的微信功能插件,运营近两年来我们收获了上千用户与良好的口碑。作为一个开源产品,希望大家都能参与进来为SOPHP添砖加瓦,SOPHP团队一直都在致力于让SOPHP更加优秀。
3. 运行与调试插件
按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS),输入 “Developer: Launch Extension” 启动插件调试环境。这时会打开一个新 VS Code 窗口(Extension Development Host),在里面按 Ctrl+Shift+P 输入 “Hello”,就能看到你注册的命令。
- 点击运行后,右下角弹出提示即表示成功
- 可在
extension.ts中打断点,调试器会自动附加 - 修改代码保存后,调试窗口按 Ctrl+R 可热重载(无需重启整个窗口)
4. 打包并本地安装
开发完成后,用 vsce 打包发布(先 npm install -g vsce):
- 在项目根目录运行 vsce package,生成
.vsix文件 - 在 VS Code 中按 Ctrl+Shift+P → 输入 “Extensions: Install from VSIX”,选中该文件即可安装
- 安装后重启 VS Code,命令就能在任意工作区使用了
如果只是临时测试,也可以直接在调试窗口里用 “Extensions: Show Installed Extensions” 查看并启用你的插件。
基本上就这些。不需要懂复杂概念,先让 “Hello” 弹出来,再逐步加状态栏、编辑器交互、配置项等功能。VS Code 插件生态成熟,文档清晰,动手试一次比读十页指南更管用。









