简介
git-contributors 是一个基于 Git 历史记录生成项目贡献者列表的 npm 包。它可以帮助我们更好地了解项目的贡献者和他们的工作，同时也可以方便地将这些信息嵌入到项目中。
本文将介绍如何使用 git-contributors 包，并提供相应示例代码。
安装
你可以通过在终端中运行以下命令来安装 git-contributors：
npm install -g git-contributors
使用
生成贡献者列表
要生成贡献者列表，请进入项目目录并运行以下命令：
git log --format="%aN <%aE>" | sort -u | git-contributors > CONTRIBUTORS.md
这个命令将会列出所有提交者的名字和电子邮件地址，并将其传递给 git-contributors。然后，它将会创建一个名为 CONTRIBUTORS.md 的文件，其中包含项目的贡献者列表。
配置选项
git-contributors 还支持多种自定义选项：
-t,--title：指定输出文件的标题。-o,--output：指定输出文件的路径。-a,--avatar-size：指定贡献者头像的大小（以像素为单位）。-l,--show-login：在贡献者列表中显示 GitHub 登录名。-s,--sort-by：按指定方式排序贡献者列表。可选的值包括commits、additions、deletions和name。
例如，如果想要将生成的贡献者列表输出到 docs/CONTRIBUTORS.md 文件中，并且带有自定义标题“Contributors”，可以使用以下命令：
git log --format="%aN <%aE>" | sort -u | git-contributors -t "Contributors" -o "docs/CONTRIBUTORS.md"
将贡献者列表嵌入项目
要将贡献者列表嵌入到你的项目中，只需将 CONTRIBUTORS.md 文件复制到适当的位置即可。然后，你可以根据需要在页面中添加链接或其他元素以引用该文件。
示例代码
以下是一个示例 package.json 文件，其中包含了 git-contributors 的配置信息：
-- -------------------- ---- -------
-
------- -------------
---------- --------
-------------- --- ------- ---------
--------- ----- --- -----------------------
--------------- -
-
------- ----- -----
-------- ----------------------
------ -----------------------------
--------- ------------------------------------------------------
--
-
------- ----- -----
-------- ----------------------
------ -----------------------------
--------- ------------------------------------------------------
-
--
---------- -
--------------- ---- --- -------------- ------- - ---- -- - ---------------- - ----------------
--
------------------ -
------------------- --------
-
-在上面的示例中，我们使用了 contributors 字段来列出项目的贡献者列表。同时，在 package.json 文件的 scripts 中添加了一个名为 contributors 的命令，该命令将调用 git-contributors 并将其输出保存到 CONTRIBUTORS.md 文件中。然后，我们可以使用 npm run contributors 命令来生成贡献者列表。
结论
通过使用 git-contributors，我们可以轻松
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/45666