Composer怎么编写配置说明？优化开源库的可用性

你可能会觉得，给开源库写配置说明就是往 composer.json 里塞几个字段，填得越全越好。但真相是：配置说明不是靠字段堆出来的，而是靠结构、约定和少量关键字段协同完成的。写错地方，用户翻遍代码也找不到；写对了，连 README 都不用点开就能直接上手用。

description 字段不是安装指南，是搜索入口

它出现在 Packagist 搜索结果和 composer show 输出里，但长度被截断到大约 80 个字符，而且不支持任何链接渲染或 Markdown。如果你把安装命令、文档地址、大段形容词塞进去，就等于主动放弃“被找到”的机会。

• ✅ 正确写法："description": "PSR-14 event dispatcher with lazy listener resolution"——主语是包本身，动词+名词组合，没有空格导致的缩写歧义。
• ❌ 错误写法："description": "Install with composer require vendor/name. See docs at https://..."——Packagist 不解析链接，也不会显示完整字符串。
• ⚠️ 常见坑：改完 composer.json 后 Packagist 页面没变？不是缓存问题，是没触发同步。GitHub push 之后需要 webhook 或手动 fetch 才会更新。

scripts 是唯一能执行的“配置说明载体”

scripts 字段是 composer.json 里唯一能被 composer run-script 真正调用的地方，特别适合封装那些带上下文的命令——比如初始化配置、生成默认文件、检查环境依赖。想想看：用户刚 require 你的包，一条命令就能自动完成后续操作，这体验比看文档舒服得多。

• 用数组形式支持多步操作："post-install-cmd": ["@php bin/init-config.php", "chmod +x bin/run.sh"]
• PHP 回调必须是 public static 方法，而且类已经通过 autoload 注册，否则报的是 Class not found，不是脚本错误——这个坑很隐蔽。
• 别把 autoload 相关的逻辑塞进 post-install-cmd。更精准的选择是 post-autoload-dump，而且 composer require 也会触发它。

README.md 才是真正的配置说明书

Composer 本身根本不读 README，但 GitHub、GitLab、IDE、Packagist 全都自动渲染它。用户第一眼看到的安装/配置步骤，99% 来自这里。所以所有配置说明应该集中放在 README 里，而不是散落到 composer.json 的各种字段中。

• 根目录 README.md 必须包含：安装命令（composer require vendor/name）、最小 PHP 版本、必需扩展、基础配置示例（比如 config/*.php 文件的结构）、环境变量说明。
• 不要把 README.md 第一行复制进 description——摘要 ≠ 文档，重复反而稀释信息密度。
• 如果包需要发布后额外配置（像 Lara vel Service Provider），在 README 里明确写清楚 config/app.php 加哪一行、php artisan vendor:publish 是否必要。

keywords 和 type 影响用户能否找到你

这两个字段不参与代码运行，但决定了 Packagist 的搜索排序和分类。填错了就等于主动隐身。

• keywords 填 3–5 个真实的搜索词，比如 ["event-dispatcher", "psr-14", "lazy-loading"]；千万别塞 ["php", "library"] 这种毫无区分度的词。
• type 必须准确："library"（默认，可被其他包 require）、"project"（独立应用，不应被 require）、"metapackage"（只触发依赖安装）。填错会导致 Packagist 分类异常，甚至 CI 构建失败。
• 含短横线的 keyword（比如 "psr-14"）必须加双引号，否则 JSON 解析失败，整个 composer.json 直接无效。

最后还有一点最容易被忽略：所有配置说明（包括 scripts 封装的命令）都依赖 autoload 正确生效。你改完 psr-4 映射却不跑 composer dump-autoload，脚本里的类就永远加载不到——而且 Composer 不会提示你漏了这一步。所以，写配置说明之前，先确保 autoload 是活的。