VSCode插件打包时从.vsix文件排除无关内容的方法

夜强君_9165

夜强君_9165

2026-11-16

110人浏览

原创

vsix打包默认包含项目目录下所有文件,不含自动过滤;不该进的有node_modules、.git、dist/out、.env等,须用.vscodeignore显式排除。

vscode插件打包时从.vsix文件排除无关内容的方法

vsix打包默认包含什么,哪些不该进

VS Code 打包生成 .vsix 时,本质是把插件项目目录(含 package.json)压缩成 ZIP,并附加签名和元数据。它不会自动过滤掉 node_modules、.git、dist 或临时文件——只要它们在当前目录下,就会被塞进去。结果就是:体积虚高、安装慢、甚至因含敏感文件(如本地 .env)导致安全风险。

常见误操作是直接在项目根目录执行 vsce package,却没清理或声明排除规则。你得主动告诉 vsce “哪些东西别打包”。

用 .vscodeignore 精确控制打包内容

.vscodeignore 是 vsce 唯一认的打包过滤文件,作用类似 .gitignore,但只影响 .vsix 构建过程,不影响 Git 或 VS Code 的文件显示。

  • 必须放在项目根目录,文件名严格为 .vscodeignore(不能是 .vscode/ignore 或其他变体)
  • 语法支持 # 注释、通配符 * 和双星号 **,不支持 ! 取反
  • 推荐基础内容:
node_modules/
.git/
.gitignore
.nyc_output
coverage/
dist/
out/
*.log
.env
.vscode/

注意:dist/ 和 out/ 要写斜杠结尾,否则可能只排除同名文件而非目录;.vscode/ 必须显式排除,否则可能打包进你本地调试用的 launch.json。

为什么 files.exclude 和 search.exclude 对打包无效

这两个设置只作用于 VS Code 编辑器运行时行为:files.exclude 控制资源管理器是否显示文件,search.exclude 控制 Ctrl+Shift+F 搜索范围。它们完全不参与 vsce 打包流程。

有人试图在 settings.json 里加规则来“让打包自动忽略”,这是徒劳的。vsce 不读取任何 VS Code 用户或工作区配置,只认 .vscodeignore 和实际文件系统路径。

另外,vsce package 也不会检查 package.json 中的 files 字段——那是 npm publish 用的,对 vsix 无效。

VSCode
VSCode

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

下载

验证打包结果是否干净

打包完别急着发,先解压检查内容是否符合预期:

  • 把 my-extension-1.0.0.vsix 后缀改成 .zip,用任意解压工具打开
  • 确认根目录只有 package.json、extension.js(或 src/)、图标等必要资源
  • 重点检查有没有意外出现的 node_modules/(哪怕只有一层空目录)、.git/ 或大体积日志文件

如果发现漏排除,改完 .vscodeignore 后必须删掉已生成的 .vsix 文件再重跑 vsce package——vsce 不会增量更新,旧包不会自动刷新。

容易被忽略的细节:TypeScript 编译产物和 source map

如果你用 TypeScript 开发插件,默认 tsc 输出到 out/ 或 dist/,而这些目录很可能被你当成“源码一部分”忘了排除。更隐蔽的是:即使你配置了 "outDir": "out",如果 tsconfig.json 里开了 "sourceMap": true,.map 文件也会生成并打进 vsix。

除非你明确需要调试发布版(极少见),否则应确保:

  • .vscodeignore 包含 out/、dist/、**/*.map
  • package.json 的 main 字段指向编译后入口(如 out/extension.js),而不是 src/extension.ts

否则用户安装后看到的可能是未编译的 TS 源码,或者因缺少 out/ 目录而报错 Cannot find module './out/extension'。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1635

18

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

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

2023.07.21

3572

3

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

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

2024.03.14

2169

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

热门下载

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

精品课程

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