post-create-project-cmd钩子在composer create-project时自动执行配置任务,需定义在模板项目的composer.json的scripts中,仅触发一次且支持多命令顺序执行。

在用 composer create-project 初始化新项目时,post-create-project-cmd 钩子能自动执行配置任务,比如生成.env文件、初始化Git、设置权限或运行安装脚本——关键在于把它写进项目的 composer.json 的 scripts 区块里,并确保它只对新项目生效。
在模板项目中声明 post-create-project-cmd
这个钩子不会在你本地开发模板时触发,只会在别人用 create-project 基于你的包生成新项目时运行。所以必须把脚本定义放在**被当作模板的项目**(比如你的 Laravel starter 或自研框架骨架)的 composer.json 中:
- 打开模板项目的
composer.json - 在
"scripts"下添加:"post-create-project-cmd": ["php -r \"copy('.env.example', '.env');\"", "php artisan key:generate"]
(注意:这是数组,支持多个命令,按顺序执行) - 如果命令依赖扩展或 Artisan 等,建议用
php ./artisan而非全局php artisan,避免环境差异
区分环境,避免重复执行
该钩子在 create-project 结束后立即运行,但不会在后续 composer install 时再触发——这点和 post-install-cmd 不同。不过仍要注意:
- 不要在钩子里做“仅首次”的判断逻辑(比如检查 .env 是否存在再复制),因为 Composer 已保证它只运行一次
- 若需条件执行(例如仅当在 Linux 上才设 chmod),可用 shell 判断:
"sh -c 'if [ \"$(uname)\" = \"Linux\" ]; then chmod -R 755 storage bootstrap/cache; fi'" - PHP 脚本中可用
getcwd()获取新项目根目录,无需硬编码路径
支持跨平台与错误处理
Windows 用户可能无法直接运行 shell 命令,所以推荐优先使用 PHP 脚本封装逻辑:
- 新建
scripts/after-create.php,内容如: - 在
composer.json中调用:"post-create-project-cmd": ["php scripts/after-create.php"] - 加上
set -e或 PHP 中检查file_exists('.env.example'),防止因缺失文件导致静默失败
验证是否生效
最简单的测试方式是:在本地用模板包路径运行 create-project(不走 packagist):
composer create-project --working-dir=./test ./path/to/your/template- 观察终端输出是否打印脚本执行日志(Composer 默认显示执行的命令)
- 检查
./test/.env是否生成、APP_KEY是否已写入 - 若没反应,确认模板项目的
composer.json已提交,且没有被.gitattributes或archive配置排除
基本上就这些。它不复杂但容易忽略——重点不是写多炫的脚本,而是让新项目开箱即用的第一步稳稳落地。










