composer scripts是什么，如何自定义composer脚本？

Composer scripts 可在执行安装、更新等命令时自动触发自定义任务。通过 composer.json 的 scripts 字段定义，支持 shell 命令、PHP 静态方法或闭包函数。常见事件包括 pre-install-cmd、post-update-cmd 等，用于清理缓存、生成文件或初始化项目。脚本按定义顺序执行，需确保可自动加载类文件并兼容多平台环境。

Composer scripts 是 Composer 提供的一种机制，允许你在执行某些 Composer 命令（如安装、更新、卸载包等）时自动触发自定义的 PHP 函数或外部命令。它们常用于自动化项目初始化、清理缓存、生成文件、运行测试等任务。

常见的 Composer 脚本事件

Composer 内置了许多事件钩子，可以在特定生命周期中执行脚本。例如：

• pre-install-cmd：在执行 install 前触发
• post-install-cmd：install 完成后执行
• pre-update-cmd：update 命令前执行
• post-update-cmd：update 完成后执行
• post-autoload-dump：自动加载文件生成后执行
• post-create-project-cmd：项目创建完成后执行，适合初始化设置

如何定义自定义脚本

你可以在项目的 composer.json 文件中通过 scripts 字段来注册脚本。支持直接执行命令或调用类的静态方法。

例如，在依赖安装完成后清除缓存：

"scripts": {
    "post-install-cmd": [
        "echo '清理缓存...'",
        "rm -rf cache/"
    ]
}

先定义一个处理类：

<?php
// scripts/MyScript.php
class MyScript
{
    public static function postUpdate($event)
    {
        echo "依赖已更新，当前环境：";
        print_r($event->getComposer()->getConfig()->get('vendor-dir'));
    }
}

然后在 composer.json 中引用：

稿定AI文案

小红书笔记、公众号、周报总结、视频脚本等智能文案生成平台

45

查看详情

"scripts": {
    "post-update-cmd": "MyScript::postUpdate"
}

注意：类文件需要能被自动加载，建议放在 scripts/ 目录并加入 autoload：

"autoload": {
    "classmap": ["scripts/"]
}

在开发环境中，也可以使用匿名函数：

"scripts": {
    "pre-install-cmd": [
        "echo '准备安装依赖...'"
    ]
}

运行自定义脚本

脚本会在对应事件发生时自动执行。比如运行：

composer install

会触发 pre-install-cmd 和 post-install-cmd 中定义的脚本。

你也可以手动触发某个事件中的脚本（如果定义了）：

composer run-script post-update-cmd

注意事项

• 脚本执行顺序是按你在数组中定义的顺序进行的
• 如果某个脚本返回非零状态码，Composer 会中断后续操作
• 生产环境中应避免执行耗时或危险操作
• 确保脚本兼容不同操作系统（如 Windows 与 Linux 路径差异）

以上就是composer scripts是什么，如何自定义composer脚本？的详细内容，更多请关注php中文网其它相关文章！