如何制作自己的VSCode插件.vsix文件?初学者打包教程

胖丽姑娘_3478

胖丽姑娘_3478

2026-11-17

954人浏览

原创

vsce package 可直接生成 .vsix 文件,但初学者常因未全局安装 vsce、package.json 中 engines.vscode 版本不匹配(须 ≥ 当前 VS Code 版本)、main 字段指向的入口文件不存在(需先编译)、或 README.md 为空/命名错误而失败。

如何制作自己的vscode插件.vsix文件?初学者打包教程

直接用 vsce package 就能生成可安装的 .vsix 文件,但多数初学者卡在环境没配对、package.json 版本不匹配、或 README.md 校验失败这三处。

vsce 工具必须全局安装且版本兼容

vsce 是官方打包工具,不是可选插件——它负责读取 package.json、编译源码(如果用了 TypeScript)、校验字段、生成压缩包。没装它,npm run package 也跑不起来(除非你手动配置了等效脚本)。

  • 运行 npm install -g vsce 安装;Windows 用户若报权限错误,加 --location=global
  • 装完执行 vsce --version,确认输出不是 command not found
  • VS Code 当前版本(2026 年 10 月稳定版是 1.118.x)必须 ≥ package.json 中 "engines": {"vscode": "^1.118.0"} 的最低要求,否则 vsce package 直接报错退出

package.json 的 engines 和 main 字段必须真实有效

这两个字段是打包时的硬性检查点,错一个就停。

VSCode
VSCode

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

下载
  • "engines": {"vscode": "^1.118.0"}:不能写成 "^1.87.0" 或留空;查自己 VS Code 版本的方法是打开帮助 → 关于,看第一行数字
  • "main": "./out/extension.js":如果你用的是 TypeScript,默认构建输出到 out/ 目录;如果没运行过 tsc -p ./ 或 npm run compile,这个文件根本不存在,vsce 会提示 Extension entry point not found
  • 改完 package.json 后必须重新运行编译命令(如 npm run compile),不能只改 JSON 就打包

README.md 不是摆设,但可以极简绕过校验

vsce package 默认强制检查 README.md 是否含有效内容,否则报 ERROR Make sure to edit the README.md file...。这不是发布限制,而是打包时的 lint 规则。

  • 正式发布前当然要写完整,但本地测试阶段,只需让文件“不为空且不含纯 README 字符串”即可
  • 执行 echo "# My Extension" > README.md(Linux/macOS)或 echo # My Extension > README.md(PowerShell)就能通过
  • 别删掉 README.md 文件本身——vsce 会直接报找不到文件
  • 注意文件名大小写:必须是 README.md,不是 readme.md 或 Readme.md

真正容易被忽略的是:每次改完 src/extension.ts 后,如果没重新编译,.vsix 里打包的还是旧的 out/extension.js——你看到的“更新没生效”,大概率是这个原因,而不是插件逻辑有问题。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1655

18

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

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

2023.07.21

3612

3

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

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

2024.03.14

2189

12

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

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

2024.03.14

1767

8

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

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

2024.03.15

2647

12

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

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

2024.03.15

1878

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1302

10

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

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

2024.03.15

1156

8

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

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

2024.03.15

594

5

热门下载

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

精品课程

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