.gitignore 不由 composer 自动生成,必须由项目模板仓库根目录提供;若缺失需手动添加或用脚本补全,且需确保模板打包时未被 .gitattributes 或 git archive 排除。

composer create-project 时怎么让 .gitignore 自动出现
默认不会生成,composer create-project 只拉代码、装依赖,不碰 Git 相关文件。想自动带 .gitignore,得靠项目模板本身提供——不是 Composer 功能,是模板仓库里有没有这个文件。
实操建议:
- 确认你要用的模板(比如
laravel/laravel、symfony/skeleton)根目录下确实存在.gitignore文件;它会被原样复制到新项目中 - 如果模板没提供,
create-project后必须手动加,或者用脚本补:比如curl -o .gitignore https://raw.githubusercontent.com/github/gitignore/main/PHP.gitignore - 别指望
--stability或--no-install这类参数能影响.gitignore是否生成——它们和文件复制无关
自定义模板如何确保 .gitignore 被包含
自己维护的 Composer 模板(type=project)必须把 .gitignore 放在仓库根目录,且不能被 .gitattributes 或 .gitignore 自身排除。否则 create-project 拉下来的 zip 包里就没有它。
常见错误现象:
- 本地开发时
.gitignore被.gitattributes设为 export-ignore,导致打包时被剔除 - CI 构建模板时用了
git archive,但没加--prefix或忽略了未跟踪文件 - 模板用了
composer.json的archive配置,却漏写了.gitignore在exclude列表外
检查方法:运行 composer create-project vendor/template myproject --no-install,进 myproject 看有没有 .gitignore;没有就回头修模板仓库。
为什么 vendor 目录常被漏写进 .gitignore
很多手写或半自动生成的 .gitignore 只写了 vendor/,但实际需要更严谨的写法,否则可能误删或误提交。
推荐写法(直接复制可用):
vendor/ !vendor/bin/ !vendor/autoload.php
说明:
-
vendor/是必须的,否则整个依赖目录会被提交 -
!vendor/bin/解除忽略,因为有些项目需要把vendor/bin/phpunit这类可执行文件软链进bin/或直接提交 -
!vendor/autoload.php是为了支持某些部署场景(如无 Composer 环境),但多数情况不用加——得看你的部署流程是否依赖它 - 别写
*/vendor/,容易漏掉顶层vendor/;也别写vendor/*,会漏掉.git子目录导致后续 git 命令异常
用 composer-init + 脚本补全 .gitignore 的边界情况
如果你是从空目录开始 composer init,那连模板都没有,.gitignore 肯定不会凭空出现。这时候只能靠后置脚本或约定动作。
实操建议:
- 在团队内部统一一个初始化脚本,比如
bin/init-project,里面顺序执行:composer init→git init→curl -fsSLO https://raw.githubusercontent.com/github/gitignore/main/PHP.gitignore && mv PHP.gitignore .gitignore - 注意 Windows 下
curl可能不可用,换成Invoke-WebRequest或提醒用户手动下载 - 别把
.gitignore写死在composer.json的scripts里自动 fetch——不同项目对忽略规则有差异,硬编码反而容易出错
最麻烦的情况其实是多层嵌套项目(比如 monorepo 子包),每个子包都要有自己的 .gitignore,但 create-project 不支持指定子路径。这种时候,模板就得提前把结构和忽略规则都设计好,不能靠后期补。










