信息发布→ 登录 注册 退出

如何在 composer.json 中定义项目的描述、许可证和作者信息?

发布时间:2025-12-27

点击量:
在 composer.json 中通过 description、license 和 authors 字段定义项目描述、许可证和作者信息,提升可发现性、合规性与协作透明度;description 限120字内,license 需符合 SPDX 标准,authors 为含 name(必填)、email 和 homepage(可选)的对象数组。

composer.json 中定义项目描述、许可证和作者信息,只需在根对象中添加对应的字段即可。这些字段虽不直接影响依赖安装,但对包的可发现性、合规性和协作透明度很重要。

设置项目描述(description)

description 字段简明说明项目用途,建议控制在 120 字以内,便于 Packagist 等平台展示。

示例:

"description": "A lightweight PHP library for parsing and validating email addresses"

指定许可证(license)

使用 license 字段声明项目所采用的开源许可证。可填单个字符串(如 "MIT"),或多个许可证组成的数组(如双许可场景)。

常见值包括:"MIT""GPL-2.0-or-later""Apache-2.0"。注意大小写和连字符需与 SPDX 许可证标识符 一致。

示例:

"license": "MIT"
"license": ["MIT", "GPL-3.0-or-later"]

声明作者信息(authors)

authors 是一个对象数组,每个作者对象至少包含 name,推荐补充 emailhomepage(可选)。

示例:

"authors": [
{
"name": "Jane Doe",
"email": "jane@example.com",
"homepage": "https://janedoe.dev"
},
{
"name": "John Smith",
"email": "john@example.com"
}
]

基本上就这些 —— 描述清晰、许可证合规、作者可追溯,能让别人更快理解并信任你的项目。

标签:# https  # 开源  # 必填  # 虽不  # 但对  # 更快  # 很重要  # 只需  # 多个  # 是一个  # 可选  # php  # 对象  # 字符串  # 标识符  # Validating  # for  # ai  # apache  # composer  # json  # js  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!