0

0

Vscode怎样进行插件开发【教程】

狼影

狼影

发布时间:2026-01-27 16:51:09

|

386人浏览过

|

来源于php中文网

原创

VS Code插件开发需基于其扩展模型,用yo code初始化TypeScript项目,activate函数为唯一入口,命令注册须与package.json的contributes.commands严格匹配,读取文件应通过activeTextEditor而非fs,调试需正确配置launch.json指向Extension Host进程。

vscode怎样进行插件开发【教程】

VS Code 插件开发不是“配个 package.json 就能跑”,核心在于理解其扩展模型——它基于 Node.js 运行,但所有 UI 和 API 调用都必须通过 VS Code 提供的 vscode 模块桥接,且主进程(Extension Host)与编辑器本身是隔离的。

怎么初始化一个可用的插件项目

别手写 package.json 和入口文件。VS Code 官方推荐用 yo code 脚手架,它会生成带调试配置、基础命令注册、tsconfig 的 TypeScript 项目(强烈建议用 TS,JS 里类型错位极难排查):

npm install -g yo generator-code
yo code

选 “New Extension (TypeScript)”,填完名字后,npm install 完就能 Ctrl+Shift+P → Developer: Launch Extension 启动调试。注意:生成的 extension.tsactivate 函数是插件唯一入口,所有注册逻辑(比如 vscode.commands.registerCommand)必须在这里完成,延迟注册会导致命令不可见。

为什么你的命令注册了却点不亮

常见原因不是代码写错,而是没在 package.jsoncontributes.commands 里声明,或声明的 command 字符串和 registerCommand 第一个参数不一致。VS Code 不会报错,只是静默忽略。

  • contributes.commands 是用户可见的元信息(标题、图标),不声明 = 命令无法出现在命令面板
  • commands.registerCommand('myExt.sayHello', ...) 中的 'myExt.sayHello' 必须和 package.jsoncommand 字段完全匹配(包括大小写)
  • 如果想让命令支持右键菜单,还得额外配 contributes.menus,且 when 条件要合理(例如 editorTextFocus 表示当前编辑器有焦点)

如何安全读取/修改当前打开的文件内容

别直接用 Node.js 的 fs.readFile——它读的是磁盘文件,而 VS Code 缓存了未保存的编辑状态。正确方式是通过 vscode.window.activeTextEditor 获取编辑器实例,再调用 document.getText()edit() 方法:

易优制冷机械设备网站源码1.6.9
易优制冷机械设备网站源码1.6.9

易优制冷机械设备网站源码是基于易优cms开发,适合企业进行制冷设备展示使用。程序内核为Thinkphp5.0开发,后台简洁,为企业网站而生。 这是一套安装就能建站的程序,不定期更新程序BUG,更新网站功能。 我们提供的不仅是模板这么简单,我们还提供程序相关咨询、协助安装等服务。 默认不包含小程序插件,需要另外单独购买插件。 模板安装步骤 1、请将安装包ZIP上

下载
const editor = vscode.window.activeTextEditor;
if (editor) {
  const text = editor.document.getText(); // 获取当前全部文本(含未保存改动)
  await editor.edit(editBuilder => {
    editBuilder.replace(editor.selection, 'replaced');
  });
}

注意:editor.edit() 是异步的,且必须在 if (editor) 检查后调用;否则调试时可能因无活动编辑器而抛 Cannot read property 'edit' of undefined

调试时断点不命中或控制台无输出

VS Code 插件运行在独立的 Extension Host 进程中,不是你 F5 启动的主窗口。调试配置必须指向 .vscode/launch.json 里的 “Launch Extension” 配置,且 runtimeExecutable 应为 ${execPath}(即当前 VS Code 可执行文件)。另外:

  • console.log 输出默认出现在 “Debug Console”,不是浏览器开发者工具的 console
  • 如果用了 vscode.window.showInformationMessage 等 UI 方法,它们只在被调试的子实例中生效,主 VS Code 窗口看不到
  • TypeScript 编译后源码映射(source map)失效?检查 tsconfig.json 是否启用了 "sourceMap": true"outDir": "./out"

插件开发最耗时间的往往不是功能实现,而是搞清哪些操作必须走 vscode API、哪些不能跨进程访问、以及调试路径是否真的连到了 Extension Host——这些边界比语法细节更容易卡住人。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

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

418

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

775

2023.08.22

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

212

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1498

2023.10.24

Python 自然语言处理(NLP)基础与实战
Python 自然语言处理(NLP)基础与实战

本专题系统讲解 Python 在自然语言处理(NLP)领域的基础方法与实战应用,涵盖文本预处理(分词、去停用词)、词性标注、命名实体识别、关键词提取、情感分析,以及常用 NLP 库(NLTK、spaCy)的核心用法。通过真实文本案例,帮助学习者掌握 使用 Python 进行文本分析与语言数据处理的完整流程,适用于内容分析、舆情监测与智能文本应用场景。

9

2026.01.27

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.6万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 7.5万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号