在开源社区中，维护者往往需要管理多个贡献者。在某些情况下，可能需要将某些贡献者添加到贡献者列表中，或者将一些贡献者从列表中删除。而手动更新贡献者列表是相当繁琐的事情。为了提高工作效率，我们可以使用 npm 包 @bevry/update-contributors。本文将带你学习如何使用此 npm 包。
1. 安装
打开终端，进入你的项目根目录，执行以下命令，即可安装 @bevry/update-contributors：
npm install --save-dev @bevry/update-contributors
2. 更新贡献者
@bevry/update-contributors 是一个命令行工具，它可以让你更轻松地维护你的项目贡献者。使用以下命令更新贡献者信息：
npx update-contributors
这将自动检测项目中的 Git 提交记录，并从中提取出贡献者信息。这些信息将被更新到你的 package.json 文件中的 contributors 数组中。
3. 自定义贡献者列表
如果你不想使用默认贡献者列表，可以通过创建一个 .contributorsrc 文件自定义贡献者列表。这个文件支持 JSON、YAML 和 JS 格式。
以下是一个自定义贡献者列表的示例：
-- -------------------- ---- ------- - --------------- - - ------- ----- ----- -------- ------------------- ------ -------------------------- -- - ------- ----- ----- -------- ------------------- ------ -------------------------- - - -展开代码
4. 指定 Git 仓库路径
如果你的项目不在 Git 的默认仓库路径下，或者你使用了 git submodule，你需要通过 --path 选项指定 Git 仓库的路径。以下是一个指定仓库路径的示例：
npx update-contributors --path /path/to/git/repo
5. 其他选项
除了 --path 选项，@bevry/update-contributors 还支持以下选项：
--sort-by：按照指定的排序方式对贡献者列表进行排序。可选值包括：name、commits、additions、deletions、percentage。默认是按照 commits 数目排序。--reverse：将排序结果反转。--ignore-author: 忽略某些作者的贡献。
6. 结论
通过本文，我们了解了如何使用 npm 包 @bevry/update-contributors 来自动更新项目的贡献者列表。这将帮助你更轻松地管理你的开源项目，并提高你的工作效率。当然，你还可以通过自定义贡献者列表和其他选项来满足你的需求。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedbb6bb5cbfe1ea061196e
