VSCode插件开发入门_编写属于自己的第一个VSCode插件

小丽吖_5949

小丽吖_5949

2026-04-16

185人浏览

原创

activate函数必须注册命令且package.json中activationevents与contributes.commands严格匹配,否则命令不可见、插件不加载;修改后需重载窗口,业务逻辑须封装在registercommand回调内,编译输出js至out/目录方可打包。

vscode插件开发入门_编写属于自己的第一个vscode插件

activate 函数必须注册命令,否则你在命令面板里搜不到它;package.json 里的 activationEvents 和 contributes.commands 必须严格匹配,否则插件压根不会被加载。

为什么按 F5 启动后命令面板里找不到你的命令?

最常见的原因是 package.json 没声明命令,或声明了但 ID 和 registerCommand 调用时不一致。VS Code 不会自动扫描代码里的字符串,只认 contributes.commands 数组里明确列出的 command 字段。

  • contributes.commands 中每个对象的 command 值(如 "extension.sayHello")必须和 vscode.commands.registerCommand('extension.sayHello', ...) 的第一个参数完全一致,包括大小写和点号位置
  • activationEvents 至少要包含对应命令的触发条件,比如 "onCommand:extension.sayHello";如果写成 "onCommand:extension.helloWorld" 却注册的是 sayHello,插件就不会激活
  • 改完 package.json 后必须重载窗口(Developer: Reload Window)或重启 Extension Development Host,否则新配置不生效

src/extension.ts 里该写什么逻辑?

核心就两件事:在 activate 里注册功能,在 deactivate 里清理资源。初学者常把业务逻辑直接写在 activate 外部,结果一启动就执行,而不是等用户触发命令。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 所有可交互功能(弹窗、编辑器操作、文件读写)都应封装在 registerCommand 的回调函数里,不要放在 activate 函数体顶层
  • 用 context.subscriptions.push() 管理监听器或定时器,避免内存泄漏;例如 vscode.window.onDidChangeActiveTextEditor(...) 返回的对象应被 push 进去
  • TypeScript 类型提示很有用,确保顶部有 import * as vscode from 'vscode';,否则 vscode.window.showInformationMessage 会报错

调试时看不到 console.log 或断点没反应?

VS Code 插件运行在独立的 Node.js 进程中,你看到的“主窗口”控制台(Developer Tools)是渲染进程,不是插件进程。调试必须通过 F5 启动的 Extension Development Host 窗口进行。

  • F5 启动后,打开 Extension Development Host 窗口,再按 Ctrl+Shift+P → 输入 Developer: Toggle Developer Tools,这时看到的 DevTools 才是插件进程的
  • console.log 输出默认出现在 DevTools 的 Console 面板,不是 VS Code 输出面板;想看结构化日志可用 vscode.window.showInformationMessage(JSON.stringify(obj))
  • 如果断点失效,检查 tsconfig.json 是否启用了 sourceMap: true(脚手架默认已开),且 launch.json 的 type 是 pwa-extensionHost

npm run package 失败:Error: Cannot find module './out/extension.js'

这是因为 TypeScript 源码还没编译成 JS。VS Code 插件运行的是 out/ 下的 JavaScript,不是 src/ 下的 TypeScript —— 即使你用 F5 调试成功,也不代表编译步骤被跳过。

  • 首次打包前必须先运行 npm run compile(或 npm run watch 保持监听);部分模板也支持 npm run build
  • 确认 package.json 的 main 字段指向 "./out/extension.js",而不是 "./src/extension.ts"
  • 如果用了 ts-node 或其他非标准方式绕过编译,vsce 打包时会失败,因为 marketplace 只接受标准 JS 输出

真正的难点不在写第一行 showInformationMessage,而在于理解 VS Code 插件是“事件驱动 + 延迟激活”的模型——它不常驻内存,也不主动执行,一切取决于你是否正确声明了 activationEvents 和 contributes,以及是否让 JS 运行时真正加载到那个 out/ 目录下。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode vscode插件开发

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1195

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2412

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1829

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1687

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2567

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1222

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1096

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

434

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程