项目名称必须为「vendor/name」格式,如”myorg/my-awesome-package”,vendor通常为GitHub用户名或公司域名反写,name须全小写加连字符;description、type、license虽非强制但影响Packagist显示、工具识别与CI/CD流程。
项目名称写在 name 字段里,且必须是「vendor/name」格式
Composer 不接受随意命名,name 是必填字段(除非是根项目且未发布),格式强制为两段式:用户名/包名,中间用斜杠分隔。比如 "name": "myorg/my-awesome-package" 合法,"name": "my-awesome-package" 或 "name": "myorg\my-awesome-package" 都会报错或被忽略。
常见错误现象:composer install 报 Invalid package name "xxx": name must be in the format vendor/name;或者 packagist.org 拒绝提交。
- vendor 名通常是你 GitHub 用户名、组织名,或公司域名反写(如
acme-corp) - name 部分不能含大写字母、空格、下划线(推荐全小写 + 连字符)
- 本地开发时可暂用占位符如
"name": "local/test-project",但上线前需改真实标识
description、type、license 这三个字段虽非强制,但影响实际使用
没有 description,Packagist 页面显示为空白;不设 type(如 "type": "library" 或 "type": "project"),某些工具(如 Composer 自动加载器、插件管理器)无法正确识别项目用途;license 缺失会导致 packagist 标为 “unknown”,部分企业 CI/CD 流程会直接拦截。
典型配置示例:
"license": "MIT", "description": "A lightweight config loader for PHP applications", "type": "library"
-
type值为project表示这是最终应用(如 Laravel 项目),不会被其他包 require;library才是可复用的包 - 多个许可证用数组:
"license": ["MIT", "Apache-2.0"] -
description最好控制在 120 字以内,packagist 只显示前段
别把 name 和 autoload 的命名空间搞混
name 是包的全局唯一标识,用于 Composer 生态中的查找与依赖解析;而 autoload 下的 psr-4 或 classmap 定义的是 PHP 类文件如何映射到命名空间——两者无语法绑定关系,但人为保持一致能减少混乱。