要创建 composer 的自定义骨架项目,需先初始化一个标准 Composer 包,设置 type 为 project,配置 name、require 和 extra 等字段,添加默认文件结构与占位符(如 __PROJECT_NAME__),可选 post-create-project-cmd 脚本用于初始化提示,然后发布至 Packagist,最后通过 composer create-project 命令使用该骨架生成新项目。

要为 Composer 的 create-project 命令创建一个自定义骨架项目,你需要准备一个标准的 Composer 包,它能作为新项目的模板。这个骨架项目可以包含默认文件结构、基础配置、预设依赖以及自动替换的占位符(如项目名称、命名空间等)。
1. 创建骨架项目的目录结构
新建一个目录作为你的骨架项目:
- 创建空目录,例如 my-skeleton
- 进入该目录并初始化 Composer 项目:
composer init
2. 配置 composer.json
确保 composer.json 中包含以下关键字段:
- name: 骨架包名,如
your-vendor/my-skeleton - type: 必须设置为
project,以便支持 create-project - require: 添加你希望新项目默认包含的依赖
- extra: 可添加脚本或提示信息
示例 composer.json:
{ "name": "your-vendor/my-skeleton", "type": "project", "description": "A custom skeleton for new projects", "require": { "php": "^8.1", "monolog/monolog": "^2.0" }, "autoload": { "psr-4": { "app": "src/" } }, "minimum-stability": "stable", "prefer-stable": true }
3. 添加默认文件和目录
在骨架中加入你希望每个新项目都有的文件:
你可以使用占位符变量,Composer 会在创建项目时自动替换它们:
-
__PROJECT_NAME__→ 替换为项目目录名 -
__NAMESPACE__→ 可通过脚本处理命名空间
例如,在 src/Example.php 中:
<?php namespace App; class Example { public function sayHello() { echo "Hello from __PROJECT_NAME__"; } }
4. (可选)添加 post-create-project-cmd 脚本
你可以在 composer.json 中定义脚本,在项目创建后执行清理或提示操作:
"scripts": { "post-create-project-cmd": [ "echo 'Project created! Don't forget to configure your environment.'" ] }
也可以调用 PHP 脚本进行更复杂的初始化。
5. 发布你的骨架项目
将项目推送到 git 仓库(如 github),然后提交到 Packagist:
- 访问 https://www.php.cn/link/ec811d0d775adc62776ba80fadd4ed19
- 提交你的仓库 URL
- Composer 就能识别并安装它
6. 使用你的骨架创建项目
一旦发布,其他人就可以这样使用:
composer create-project your-vendor/my-skeleton my-new-project
Composer 会:
- 克隆骨架项目
- 安装 require 中的依赖
- 执行 post-create-project-cmd 脚本
基本上就这些。关键是把骨架当作一个普通 Composer 项目来维护,并确保结构清晰、可复用。不复杂但容易忽略的是 type: project 和合理的默认文件组织。
以上就是如何为composer的create-project命令创建一个自定义的骨架项目?的详细内容,更多请关注php中文网其它相关文章!