composer run-script 命令的详细用法与实例

composer run-script用于执行composer.json中定义的脚本，支持自定义命令、参数传递、多命令组合及跨平台兼容，提升PHP项目自动化效率。

在使用 Composer 管理 PHP 项目时，composer run-script 是一个非常实用的命令，用于手动触发定义在 composer.json 文件中的自定义脚本或内置脚本。它可以帮助你自动化执行诸如测试、构建、清理、部署等任务。

什么是 composer run-script

composer run-script 命令允许你运行 composer.json 中 scripts 字段下定义的脚本。这些脚本可以是 shell 命令、PHP 脚本、Phar 工具调用等。

该命令不会自动运行依赖脚本（比如 post-install-cmd 不会因为执行 install 而被重复触发），适合用于手动调试或按需执行特定任务。

基本语法

• script：要运行的脚本名称（必须存在于 scripts 配置中）
• args：传递给脚本的额外参数（可选）
• --timeout=秒数：设置脚本执行超时时间
• --dev：启用 dev 模式，加载 require-dev 中的脚本（默认已启用）
• --no-dev：禁用 dev 模式，不加载 require-dev 脚本

常见脚本类型与实例

以下是几种常见的脚本用途和实际示例。

1. 定义并运行自定义脚本

在 composer.json 中添加一个自定义脚本：

{
    "scripts": {
        "hello": "echo 'Hello, Composer!'"
    }
}

运行该脚本：

composer run-script hello

输出：

Executing command (CWD): echo 'Hello, Composer!'
Hello, Composer!

2. 传递参数给脚本

你可以将参数传递给脚本。例如定义一个接收名字的脚本：

{
    "scripts": {
        "greet": "echo 'Hi, $1'"
    }
}

运行并传参：

composer run-script greet -- John

输出：

Hi, John

注意：参数通过 shell 变量 $1, $2 等访问（Linux/macOS）。Windows 下可能需要使用 %1%。

3. 执行 PHP 脚本或工具

你可以运行本地 PHP 脚本或安装在 vendor/bin 的工具：

{
    "scripts": {
        "test": "phpunit",
        "lint": "php -l src/*.php",
        "build": "php build.php"
    }
}

运行方式：

析稿Ai写作

科研人的高效工具：AI论文自动生成，十分钟万字，无限大纲规划写作思路。

142

查看详情

composer run-script test

这将执行 phpunit 测试套件。

4. 使用事件钩子脚本

Composer 内置了许多事件钩子，如 post-install-cmd、pre-update-dump 等。虽然它们通常自动触发，但也可以手动运行：

composer run-script post-install-cmd

例如，某些项目在安装后需要生成 autoload 文件或清除缓存，这个命令可用于重新触发这些操作。

5. 复合脚本与多命令执行

使用 && 或 ; 连接多个命令：

{
    "scripts": {
        "deploy": "git pull && composer install && php clear-cache.php"
    }
}

运行：

composer run-script deploy

该命令会依次拉取代码、安装依赖、清除缓存。

6. 跨平台兼容脚本

为避免平台差异问题，推荐使用 PHP 脚本封装逻辑，或使用 Composer 提供的 cross-exec 包：

{
    "scripts": {
        "start": [
            "@php server.php"
        ]
    }
}

其中 @php 会自动映射到当前 PHP 可执行文件，更安全可靠。

7. 调试脚本执行过程

使用 -v（verbose）查看详细执行信息：

composer run-script hello -v

输出会显示执行路径和完整命令。

若脚本卡住或超时，可通过设置超时时间控制：

composer run-script long-task --timeout=300

基本上就这些。合理使用 composer run-script 可以显著提升开发效率，让项目自动化更简洁可控。

以上就是composer run-script 命令的详细用法与实例的详细内容，更多请关注php中文网其它相关文章！