Composer archive排除文件 忽略特定文件打包技巧【进阶】

9次阅读

composer archive 默认仅依据 .gitignore 和 .gitattributes 过滤文件,不识别 .dockerignore、autoload.exclude 等;推荐用 .gitattributes 精确控制,或 Composer 2.2+ 的 config.archive.excludes 配置。

Composer archive排除文件 忽略特定文件打包技巧【进阶】

composer archive 命令默认打包哪些文件

composer archive 不是 Composer 的核心命令,它来自 composer/composer 自带的归档功能(实际由 ComposerCommandArchiveCommand 实现),但默认行为非常简单粗暴:只按 .gitignore.gitattributes 过滤,不读 .dockerignore、不认 exclude-from-classmap、也不管 autoload.exclude

这意味着:

  • 如果你没配 .gitignore,它会把 vendor/tests/phpunit.xml 全塞进去
  • 如果你用的是 svn 或没有版本控制,composer archive 会直接打包整个目录(包括 node_modules

用 .gitattributes 精确控制 archive 排除项

这是最可靠、最被 composer archive 原生支持的方式。它优先级高于 .gitignore,且明确用于归档过滤。

在项目根目录创建或编辑 .gitattributes,写入:

vendor/ export-ignore tests/ export-ignore phpunit.xml export-ignore .dockerignore export-ignore *.md export-ignore

注意点:

  • 每行一个路径模式,结尾必须加 export-ignore(不是 export-ignore 的其他值会被忽略)
  • 路径是相对于项目根的,不支持通配符如 */cache/,只支持前缀匹配(cache/ 可以,/cache/ 不行)
  • .gitattributes 本身不会被打包(Composer 内部硬编码排除了它)
  • 修改后无需 git add -fcomposer archive 直接读取文件内容

为什么 ignore-platform-reqs 不影响 archive

这是常见误解:--ignore-platform-reqs 是给 install / update 用的,和打包完全无关。archive 过程不解析 composer.json 中的 platformconfig.platform,也不会跳过任何 require-dev 包——它只管“文件是否存在+是否被 export-ignore 标记”。

所以:

  • 即使你加了 --ignore-platform-reqscomposer archive 仍会把 vendor/ 下所有已安装的包源码(含 dev 包)全打进去(如果没被 .gitattributes 排除)
  • 若你真想排除 vendor/,唯一办法就是用 .gitattributes 显式声明 vendor/ export-ignore
  • 想只打包源码不带依赖?那 composer archive 不是合适工具,应改用 git archive 或自定义 tar 命令

替代方案:用 composer config archive.excludes 更灵活

从 Composer 2.2+ 开始,支持在 composer.json 里声明归档排除规则(比 .gitattributes 更直观,且不依赖 Git):

{     "config": {         "archive": {             "excludes": [                 "/vendor",                 "/tests",                 "/.env*",                 "/phpstan.neon"             ]         }     } }

关键细节:

  • 路径以 / 开头表示项目根相对路径(/vendorvendor/
  • 支持 glob(/.env* 有效,/*/.log 无效)
  • 该配置仅被 composer archive 读取,不影响 install/update
  • 如果同时存在 .gitattributesconfig.archive.excludes,两者叠加生效(不是覆盖)
  • 注意斜杠方向:windows 用户也必须用 /,Composer 会自动转换

真正容易被忽略的是:这个配置只在本地运行 composer archive 时起作用;CI 环境若用的是旧版 Composer(composer –version 校验。

text=ZqhQzanResources