自定义模板需包含composer.json、正确type、初始化结构并托管在可访问位置,通过create-project命令结合VCS或私有仓库地址创建项目,并利用post-create-project-cmd脚本自动化配置,适用于公开或企业私有场景。

Composer 的 create-project 命令可以基于某个已有的项目模板创建新项目,比如常见的 Laravel 安装就是通过这种方式实现的。如果你想使用一个自定义的模板来创建项目,只需确保该模板是一个公开或私有的 Composer 包,并且包含正确的结构和配置。
1. 自定义模板的基本要求
要让一个项目能作为 create-project 的模板,它必须满足以下条件:
- 包含 composer.json 文件:这是必须的,其中应定义名称、类型、autoload 配置等。
- 设置正确的 type:建议设为 project 或留空(默认为 library),但不影响 create-project 使用。
- 提供可执行的初始化结构:如 src/、config/、public/ 等目录,根据你的需求组织。
- 托管在可访问的位置:如 GitHub、GitLab、私有 Packagist 服务器或可通过 VCS 拉取的地址。
示例 composer.json:
{
"name": "your-vendor/my-custom-template",
"type": "project",
"description": "A custom project template for internal use",
"require": {},
"autoload": {
"psr-4": {
"App\\": "src/"
}
},
"scripts": {
"post-create-project-cmd": [
"echo 'Welcome to your new project!'",
"php setup.php"
]
}
}
2. 使用自定义模板创建项目
只要模板项目托管在支持的版本控制系统中(如 Git),你可以直接用它的包名或仓库地址调用 create-project。
如果模板已发布到 Packagist:
composer create-project your-vendor/my-custom-template my-new-project
如果模板在私有仓库或尚未发布到 Packagist,可用 VCS 方式:
composer create-project --repository=https://github.com/your-vendor/my-custom-template.git your-vendor/my-custom-template my-new-project
或者更明确地指定类型:
composer create-project --repository='{"type": "vcs", "url": "https://github.com/your-vendor/my-custom-template"}' your-vendor/my-custom-template my-new-project
3. 利用 post-create-project-cmd 脚本初始化
你可以在模板的 composer.json 中定义 post-create-project-cmd 脚本,用于在项目创建后自动执行初始化操作,例如:
常见脚本示例:
"scripts": {
"post-create-project-cmd": [
"cp .env.example .env",
"php bin/init.php",
"rm -rf .git",
"echo 'Project created! Run `composer install` next.'"
]
}
4. 私有模板与企业内部使用
如果你的企业有私有模板,可以通过以下方式集成:
- 将模板放在私有 Git 服务器上(GitHub/GitLab/Bitbucket)
- 在全局 composer config 中添加 repository(可选)
- 确保运行命令的机器有权限克隆代码(SSH 密钥或 token)
例如使用 SSH 克隆私有模板:
composer create-project --repository=git@github.com:your-company/project-template.git your-company/project-template my-cool-app
基本上就这些。只要你的项目是一个标准的 Composer 包,就可以作为模板被 create-project 使用。关键是结构清晰、脚本能自动化初始化流程,这样团队成员就能快速启动新项目。










