如何在Composer脚本中获取当前包的版本号？动态元数据应用-composer-PHP中文网

composer脚本无法直接读取composer.json中的version字段，因其仅用于发布声明；最可靠方式是运行时调用composer show --format=json命令解析，或在ci中预先写入version.json固化版本。

如何在composer脚本中获取当前包的版本号？动态元数据应用

Composer脚本里直接读不到 `version` 字段

Composer 的 composer.json 中的 version 字段在安装后会被忽略——它只用于包发布时的版本声明，不参与运行时解析。脚本执行时，Composer\Package\CompletePackage 对象里确实没有可靠字段能直接返回“当前包的已安装版本”。常见错误是试图读取 $package->getVersion()，结果得到空值或 dev-main 这类非真实语义版本。

`composer show --format=json` 是最稳的运行时获取方式

利用 Composer 自带命令查自身信息，绕过 API 不稳定问题。前提是脚本在项目根目录下运行（即 vendor/autoload.php 可加载、且当前包已作为 root package 安装）：

在 composer.json 的 scripts 里写 shell 命令：

"scripts": {
  "show-version": "composer show myvendor/mypackage --format=json | jq -r '.version'"
}

若需 PHP 脚本中动态获取（如自动生成构建元数据），用 exec() 或 shell_exec() 调用：

$output = shell_exec('composer show ' . escapeshellarg($thisPackage) . ' --format=json 2>/dev/null');
$data = json_decode($output, true);
$version = $data['version'] ?? 'unknown';

注意：必须确保 jq 已安装（Linux/macOS），Windows 用户可改用 php -r "echo json_decode(file_get_contents('php://stdin'), true)['version'] ?? 'unknown';" 替代管道解析

用 `Package::getPrettyVersion()` 需满足两个前提

部分人尝试通过 Composer API 获取：$package->getPrettyVersion()，但这只在特定上下文中有效：

Discussion Composer

围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论（Discussion）”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性，以及撰写结论。当用户输入以下任一指令时也会自动触发该功能： - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par

下载

必须在 Plugin 或 Command 类中调用，且传入的是 root package 实例（不是依赖包）
必须确保 Composer 已完成 autoload 加载和 package 解析（即不能在 autoload-files 里提前调用）
该方法返回的是类似 1.2.3 或 dev-main 的字符串，但若包以 path repository 方式本地加载，可能返回 dev-develop 而非实际 commit hash

构建时写入版本号比运行时读取更可靠

对 CI/CD 或生成构建产物（如前端 bundle 的 meta.json）这类场景，建议把版本号固化到代码中：

CI 流程中，在 composer install 后执行：

echo "{\"version\":\"$(composer show myvendor/mypackage --no-ansi | cut -d' ' -f2)\"}" > version.json

PHP 中直接 json_decode(file_get_contents(__DIR__ . '/version.json'), true)，避免任何运行时依赖 Composer CLI 或环境
Git hook（如 post-commit）也可自动更新 VERSION 文件，配合 git describe --tags --always 获取轻量标签

真正麻烦的从来不是“怎么拿到版本”，而是“拿的时候这个版本是否还代表当前代码状态”——commit 和 tag 之间有延迟，本地开发分支和远程 release 分支可能不一致，这些都得靠流程卡点，而不是靠一行 getVersion() 解决。