0

0

如何在 composer.json 中配置 archive.exclude 来打包时忽略特定文件?

冰火之心

冰火之心

发布时间:2025-12-29 19:47:25

|

687人浏览过

|

来源于php中文网

原创

Composer 2.2+ 支持在 composer.json 根级配置 "archive": {"exclude": [...]}, 用于 composer archive 命令排除文件;旧版不支持,无效字段会被静默忽略。

如何在 composer.json 中配置 archive.exclude 来打包时忽略特定文件?

composer.json 中,没有 archive.exclude 这个配置项。这是常见误解——Composer 官方并不支持 archive.exclude 或类似字段来控制 composer archive(打包)时的文件排除。

真正可用、且被 Composer 原生支持的方式是使用 archiveexclude(注意:是顶层 archive 对象下的 exclude 数组),但前提是你要用的是 Composer 2.2+,并且这个功能仅在运行 composer archive 命令时生效(不是 install/update)。


✅ 正确配置方式(Composer 2.2+)

composer.json 的根级别添加 archive 字段:

{
    "name": "your/vendor",
    "version": "1.0.0",
    "archive": {
        "exclude": [
            "/tests/",
            "/Tests/",
            "/phpunit.xml",
            "/phpstan.neon",
            "/.gitignore",
            "/.editorconfig",
            "/docker/",
            "/*.md",
            "!/README.md"
        ]
    }
}

? 说明:

  • exclude 是一个字符串数组,每项是路径匹配模式
  • 支持通配符 * 和前导 / 表示从包根开始匹配。
  • ! 开头表示白名单反排除(即即使父目录被排除,该文件仍保留),如 "!/README.md"
  • 路径区分大小写(尤其在 Linux/macOS 环境)。
  • 不支持正则,只支持简单 glob 风格(类似 .gitignore 规则)。

⚠️ 注意:此配置不会影响 composer install 下载的 vendor 包内容,只影响你执行 composer archive 打出的 zip/tar 包。


✅ 如何生成归档包?

确保你已安装 Composer,并在项目根目录运行:

composer archive --format=zip --file=my-package-1.0.0

它会根据 archive.exclude 规则自动过滤文件。


❌ 常见错误写法(无效!)

// 错误:不存在的字段名
"archive.exclude": [...]

// 错误:放在 config 或 scripts 下
"config": {
    "archive.exclude": [...]
}

// 错误:旧版 Composer(<2.2)不识别该配置

如果你用的是 Composer 2.1 或更早版本,archive.exclude 完全不生效,会静默忽略。

Figma
Figma

Figma 是一款基于云端的 UI 设计工具,可以在线进行产品原型、设计、评审、交付等工作。

下载

检查版本:

composer --version

升级 Composer(推荐):

composer self-update

✅ 替代方案(兼容旧版或更精细控制)

如果不能升级 Composer,或需要更强控制力,可改用:

  • .gitattributes 文件(推荐)
    Composer 在 archive 时默认读取 .gitattributes 中的 export-ignore 规则:

    /tests/ export-ignore
    /phpunit.xml export-ignore
    .gitignore export-ignore
    README.md export-ignore
    !/README.md export-ignore  # 不支持反排除?实际不生效,慎用白名单

    ✅ 兼容所有 Composer 版本,也适用于 Git 自带的 git archive

  • 自定义脚本 + zip/tar 命令
    scripts 中定义打包命令,用 shell 工具手动 exclude。


基本上就这些。核心记住一点:archive.exclude 是 Composer 2.2+ 的特性,必须写在 composer.json 根层级的 archive 对象里,不是随便起个名字就行。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

147

2023.12.25

json数据格式
json数据格式

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

401

2023.08.07

json是什么
json是什么

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

528

2023.08.23

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

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

306

2023.10.13

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

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

74

2025.09.10

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

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

246

2023.08.03

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

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

204

2023.09.04

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

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

1431

2023.10.24

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.29

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.3万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 6.6万人学习

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

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