如何为 Composer 的 create-project 创建自己的项目模板?

3次阅读

composer create-project 是项目初始化工具,通过发布含 composer.json 和基础文件的模板包到 Packagist 或私有仓库,用户即可一键拉取安装;需设 type="project"、配置 post-create-project-cmd 钩子,并打稳定标签以便使用。

如何为 Composer 的 create-project 创建自己的项目模板?

你可以把 Composer 的 create-project 命令当成一个“项目初始化工具”,而项目模板就是它背后那个可复用的脚手架。核心思路是:准备一个标准的 Composer 包(含 composer.json 和基础文件),把它发布到 Packagist 或私有仓库,然后用 composer create-project 直接拉取并安装。

准备一个可复用的模板项目

新建一个目录,比如 my-company/project-template,里面放上你希望新项目一创建就有的结构和配置:

  • composer.json 必须存在,且 "type" 推荐设为 "project"(非必需但语义清晰)
  • 包含默认的 .gitignoreREADME.md、基础目录(如 src/tests/)、甚至预置的 php 类或配置文件
  • 如果需要自动替换占位符(如项目名、作者名),可配合 composer create-project--stability 和自定义脚本,但更推荐用 scripts + post-create-project-cmd

配置 composer.json 支持模板行为

在模板项目的 composer.json 中,重点设置这几项:

  • "name":格式为 vendor/name,比如 acme/laravel-starter,这是别人调用时的标识
  • "description""keywords":方便在 Packagist 搜索发现
  • "type": "project":明确类型,利于工具识别
  • "scripts" 下添加 "post-create-project-cmd":这个钩子会在 create-project 完成后立即执行,适合做初始化清理、重命名、生成密钥等操作

例如:

"scripts": {   "post-create-project-cmd": [     "@php -r "copy('env.example', '.env');"",     "@php -r "file_put_contents('.env', str_replace('app_NAME=MyApp', 'APP_NAME=' . getenv('APP_NAME'), file_get_contents('.env')));""   ] }

发布模板并让别人能用

模板本身就是一个普通 Composer 包,所以发布流程和普通包一致:

如何为 Composer 的 create-project 创建自己的项目模板?

无限画

千库网旗下ai绘画创作平台

如何为 Composer 的 create-project 创建自己的项目模板? 574

查看详情 如何为 Composer 的 create-project 创建自己的项目模板?

  • 把代码推送到 github/gitlab 等平台(公开或私有)
  • 在 Packagist.org 提交该仓库(如果是私有仓库,需配置 repositories
  • 确保版本有稳定标签(如 v1.0.0),否则 create-project 默认只拉 stable 版本

用户就能这样使用:

composer create-project acme/laravel-starter my-new-app

小技巧:跳过交互、指定版本、定制安装

实际使用时可以加参数提升效率:

  • --no-interaction:跳过所有提示(适合 CI 或批量创建)
  • --stability=dev:拉取 dev-maindev-develop 分支
  • --repository-url=https://my-repo.com:指向私有仓库
  • --remove-vcs:初始化完立刻删掉 .git 目录,避免继承模板的提交历史

基本上就这些。不复杂但容易忽略的是:模板不是“黑盒生成器”,它本质是一个带钩子的 Composer 包,越贴近标准实践,兼容性和可维护性越好。

以上就是如何为 Composer 的 create-project 创建自己的项目模板?的详细内容,更多请关注php中文网其它相关文章!

text=ZqhQzanResources