前言
随着社区的发展和前端项目的复杂度越来越高，越来越多的开发者寻求对自己项目的贡献者进行管理。all-contributors 就是一个优秀的解决方案。而 @auto-it/all-contributors npm 包则是 all-contributors 的增强版，它通过添加许多新的功能帮助我们更好地管理项目的贡献者。
在本篇文章中，我们将深入介绍 @auto-it/all-contributors 包并提供实际示例代码以帮助开发者更好地理解其使用。
了解 @auto-it/all-contributors
@auto-it/all-contributors 是针对 all-contributors 做了增强的 npm 包，其中包含了一些新的功能和特性，例如指定不同的组织规则来管理特定的项目以及自定义 emoji 等。这种扩展带来了更高的灵活性和可定制性，在更大或更复杂的团队中管理贡献都变得更加简单。
该包还有其他一些功能：
- 更好的贡献者管理，包括将贡献者分成不同的组。
- 可以自定义贡献者类型和 emoji。
- 可以确定特定组织的贡献者具有不同的组织规则。
在了解了 @auto-it/all-contributors 的一些主要功能后，我们现在可以开始使用该包了。
使用 @auto-it/all-contributors
安装
首先，在你的项目中安装 @auto-it/all-contributors：
npm install @auto-it/all-contributors --save-dev
添加配置
在你的项目根目录添加 .all-contributorsrc 文件作为配置文件。
-- -------------------- ---- -------
-
-------------- --- ---------
--------------- -----------------
----------- ---------
----------- -------------
----------- --------------------------------
-------- -
-----------
--
--------------- -
-------- -
------- -------------
-------------- ---------
--
-------- -
-------
-------
-----
-------
-----
-----
-----
----
-
--
-------------------- -
-
------- ------
-------- --------
--------------- -
-------
------
-
--
-
------- ------
-------- -----
--------------- -
------
-------
-
-
-
-在上述示例代码中，我们设置了一些默认的项目信息、贡献者分组规则、自定义 emoji 和贡献类型。在添加完配置文件后，我们可以使用以下命令来检查当前参与者：
npx @auto-it/all-contributors check
在执行该命令后，你可以看到贡献者列表以及他们的贡献类型和 emoji。
添加贡献者
当有新的贡献者加入我们的项目时，可以使用以下命令将他们添加到贡献者列表：
npx @auto-it/all-contributors add <username> <contributionType> [options]
示例：
npx @auto-it/all-contributors add john909 "adds a new feature" npx @auto-it/all-contributors add jenny58 "fixes an issue"
生成贡献者列表
当开发者想要获得一个完整的贡献者列表时，可以使用以下命令：
npx @auto-it/all-contributors generate
在该命令执行后会更新 .all-contributorsrc 文件，并在上述列表中添加贡献者。该命令还会自动将该列表插入到你指定的所有文件中。
除了上述命令外，所有 all-contributors 提供的命令都可以使用，可以在 all-contributors/automated-tools 找到更多详细信息。
结束语
本文我们学习了如何使用 @auto-it/all-contributors 包来更好地管理项目的贡献者。我们了解了该包的一些主要功能，添加了配置文件并添加了新的贡献者。但是，这些只是开始。你可以使用该包的其他特性来更好地定制和管理贡献者列表。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eeda80acebd9a1b02fbaaee