如何在Composer脚本中获取当前项目的根目录？

最可靠的方式是通过Composer的ScriptEvent对象获取根目录。使用 $event->getComposer()->getConfig()->get('vendor-dir') 获取vendor路径，再通过 realpath() 或 dirname() 反推根目录，确保准确性和兼容性。该方法优于依赖 getcwd() 或 $_SERVER['PWD'] 的上下文敏感方式。示例代码展示了如何在自定义脚本中实现，并推荐在 composer.json 中正确注册脚本以接收事件对象，从而安全获取项目根目录。

在Composer脚本中获取当前项目的根目录，最可靠的方式是使用Composer提供的API来访问项目路径。你可以通过 $composer 对象或环境变量间接获取根目录。

使用 Composer 的 IO 和 Event 对象

在自定义脚本中，Composer 会传入一个 ScriptEvent 对象，从中可以获取 Composer 实例，进而访问项目根目录。

use ComposerScriptEvent;
use ComposerUtilFilesystem;

public static function yourCustomScript(Event $event)
{
    // 获取 Composer 实例
    $composer = $event->getComposer();

    // 获取项目根目录（即 composer.json 所在目录）
    $rootDir = $composer->getConfig()->get('vendor-dir') . '/..';
    $rootDir = realpath($rootDir);

    echo "项目根目录: " . $rootDir . PHP_EOL;

    // 或者更直接地：从 vendor 目录推断根目录
    $filesystem = new Filesystem();
    $vendorDir = $composer->getConfig()->get('vendor-dir');
    $rootDir = dirname($filesystem->normalizePath($vendorDir));

    echo "根目录: " . $rootDir . PHP_EOL;
}

通过环境变量或路径推断

如果你的脚本是外部PHP文件或命令行调用，也可以通过 $_SERVER['PWD'] 或 getcwd() 获取当前工作目录，前提是执行 Composer 命令时位于项目根目录。

// 获取当前工作目录（通常就是项目根目录）
$rootDir = getcwd();
echo "当前工作目录: " . $rootDir . PHP_EOL;

注意：这种方法依赖执行上下文，不如 Composer API 可靠。

Elser AI

一站式AI动漫、短剧生成平台

下载

配置 scripts 在 composer.json 中

确保你的脚本注册正确，以便接收事件对象：

{
    "scripts": {
        "post-install-cmd": "Your\Class::yourCustomScript",
        "post-update-cmd": "Your\Class::yourCustomScript"
    }
}

基本上就这些。推荐优先使用 $event->getComposer()->getConfig() 来获取配置路径，再反推根目录，这是最兼容且安全的方式。不复杂但容易忽略细节。