讲师中心 微信公众号
AI工具推荐 视频效率加速

如何利用VSCode的插件开发功能创建自定义扩展【教程】

云浩酱_4650

云浩酱_4650

发布时间:2026-01-25 17:14:03

|

639人浏览过

|

来源于php中文网

原创

VSCode扩展开发必须安装Node.js(v16+)和VSCode,全局安装yo与generator-code脚手架;执行yo code生成项目后,需验证F5调试、命令触发及activationEvents按需激活配置,并注意console.log输出位置与断点调试条件。

VSCode 扩展开发需要哪些基础工具

必须装好 node.js(v16+)和 vscode 本身,yo 和 generator-code 是脚手架核心——不装它们,npm init vscode-extension 这类命令根本跑不起来。

执行前先全局安装:

npm install -g yo generator-code
注意:如果用 pnpm 或 yarn,得对应加 -g 参数,否则 yo code 会报“command not found”。

常见卡点:

  • Node 版本太低(vscode-extension-telemetry 等依赖会编译失败)
  • PowerShell 默认执行策略禁止运行脚本(Windows 用户常遇到 yo : The term 'yo' is not recognized)
  • 国内网络下 npm install 卡在 vscode-test 下载二进制,建议提前配置 NODE_OPTIONS=--max_old_space_size=4096 并换淘宝镜像

从 yo code 到可调试的扩展项目

运行 yo code 后,它会问你语言(TypeScript 推荐)、扩展名、ID、描述等。ID 会成为 package.json 中的 publisher.id,后续发布时不能改。

生成完别急着写逻辑,先验证环境:

  • 按 F5 启动 Extension Development Host——这是个带你的扩展的独立 VSCode 实例
  • 打开命令面板(Ctrl+Shift+P),搜 Hello World,能触发说明基础结构通了
  • 修改 src/extension.ts 里的 console.log,保存后按 Ctrl+R 重载窗口,看输出是否更新

容易忽略的一点:activationEvents 决定扩展何时加载。默认是 "*"(一启动就加载),但实际应尽量设为 ["onCommand:extension.helloWorld"] 这类按需激活,否则影响主进程启动速度。

Linux Security Scanner
Linux Security Scanner

Linux 安全审计工具,检查 SSH 配置、开放/监听端口、防火墙规则(ufw/iptables/nftables)、失败登录尝试、sudoers 权限...

下载

package.json 里最关键的 4 个字段

这不是普通 npm 包,VSCode 靠这几个字段识别行为:

  • main:入口 JS 文件路径(构建后指向 ./out/extension.js,不是 src/ 下的 ts)
  • activationEvents:上面提过,错配会导致命令不可见或延迟响应
  • contributes.commands:声明所有可用命令,ID 必须和 registerCommand 第一个参数完全一致(大小写敏感)
  • contributes.menus:比如想把命令加到编辑器右键菜单,得写 "editor/context" 而不是 "editor/title",拼错就不出现在菜单里

示例片段:

"contributes": {<br>  "commands": [{<br>    "command": "extension.insertTimestamp",<br>    "title": "Insert Timestamp"<br>  }],<br>  "menus": {<br>    "editor/context": [{<br>      "when": "editorTextFocus",<br>      "command": "extension.insertTimestamp"<br>    }]<br>  }<br>}

调试时看不到 console.log?去开发者工具找

VSCode 扩展的 console.log 不输出在终端,而是在 Extension Development Host 的开发者工具里——按 Ctrl+Shift+I(Windows/Linux)或 Cmd+Option+I(macOS),切到 Console 面板。

更可靠的调试方式是打断点:

  • 确保 launch.json 的 type 是 extensionHost
  • 在 src/extension.ts 里设断点,F5 启动后操作触发命令,自动停住
  • 如果断点灰掉,检查 out/ 是否存在且 source map 正确(tsconfig.json 中 sourceMap 和 inlineSources 都要为 true)

一个硬伤:VSCode 1.85+ 对某些 webview 场景的调试支持变弱,若涉及复杂 UI,建议直接用 vscode.env.openExternal 打开浏览器调试页面。

热门AI工具

更多
Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

312

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

520

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

391

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

306

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

678

2026.06.16

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2215

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3522

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1176

2023.10.13

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

Buffalo框架快速入门指南
Buffalo框架快速入门指南

共0课时 | 0人学习

Valgrind支持平台说明
Valgrind支持平台说明

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn