Composer如何导出纯文本依赖列表?(用于文档记录)

2次阅读

直接用 composer show -n | sort 获取干净的包名列表,或 composer show –all –format=json | jq -r ‘.packages[] | “(.name) (.version)”‘ | sort 获取带版本的有序列表。

Composer如何导出纯文本依赖列表?(用于文档记录)

composer show 输出太乱,怎么直接拿到干净的包名列表

默认 composer show 会带版本号、描述、依赖树,不适合粘贴进文档。真正需要的只是 vendor/package-name 这种格式的一行一个。

composer show -N-N 表示 “no description”),它只输出包名,不含版本和说明,最接近纯文本需求:

composer show -N

注意:这个命令只显示已安装的包,不包含 require-dev 中未启用的包(比如本地没跑 composer install --devphpunit/phpunit 就不会出现)。

  • 如果要强制包含 dev 包,先确保它们已安装:composer install --dev
  • -N 不输出版本号,但文档里通常需要带版本——这时得换方式
  • 别用 composer show | cut -d' ' -f1 这类管道切分,字段对不齐时会截断错误(比如包名含空格或描述开头是数字)

要带版本号的纯文本列表,用 composer show –format=json 解析

JSON 输出稳定、结构清晰,适合脚本提取。核心思路是:让 Composer 输出 JSON,再用 jq 提取 nameversion

运行以下命令(需提前装好 jq):

composer show --format=json | jq -r '.packages[] | "(.name) (.version)"'

这会输出类似:

monolog/monolog 2.10.0<br>symfony/console v6.4.7

常见坑点:

  • .packages[] 只包含 production 包;要包含 require-dev 的,加 --all 参数:composer show --all --format=json
  • 有些包 version 是 dev-maindev-develop,不是语义化版本——这是正常的,表示当前指向分支而非 tag
  • 没装 jqwindows 用户可用 PowerShell 替代(但正则提取易出错),macos/linux 用户建议直接 brew install jqapt install jq

导出结果要按字母排序且去重,别手动 sort | uniq

Composer 本身不保证 show 输出顺序,尤其加了 --all 后,prod 和 dev 包混在一起。直接 sort 很必要,但要注意两点:

  • sort 默认按字典序,foo/bar 会排在 foo/baz 前面,没问题;但 v1.2.3v10.0.0 会被当成字符串比较(v10 在 v1 前),不过依赖列表一般不靠版本排序,按包名排更合理
  • 别用 uniq 去重——composer show 本身不会重复输出同一包,uniq 没意义,还可能误删(它只对相邻重复行生效)
  • 推荐组合:composer show -N | sort > deps.txt 或带版本的:composer show --all --format=json | jq -r '.packages[] | "(.name) (.version)"' | sort > deps-with-ver.txt

为什么不用 composer.lock 直接解析

composer.lock 看起来最“权威”,但它记录的是锁死状态,包含大量内部字段(如 distsourcetype),而且 packages 数组里混着 root 包、平台包(php, ext-zip)、还有被替换的包(如 psr/logmonolog/monolog 替换)。

直接读 lock 文件容易多出不该出现在文档里的条目:

  • 平台要求(php, ext-json)不是“包”,写进依赖列表反而误导
  • replace 掉的包(如 psr/log)实际未安装,但 lock 里仍有记录
  • lock 文件格式随 Composer 版本变化(v1 vs v2 lock 结构不同),脚本兼容性差
  • 真正该进文档的,是 composer.json 中声明的 + 实际安装成功的包,composer show 才反映真实状态

所以别碰 lock 文件来生成文档列表——看似底层,实则偏离目标。

导出这事本身简单,但容易卡在“以为要解析 lock”或“用 cut/grep 硬切 show 输出”上。稳住,就用 -N--format=json,再套一层 sort,够用了。

text=ZqhQzanResources