在前端开发过程中，有时候需要使用一些开源的 npm 包，但是开源的维护者们往往需要负担不小的成本，例如服务器、域名等费用。为此，npm 在 2019 年推出了 Sponsor，允许开源维护者接受赞助。而 sponsorama 就是一款可以为 npm 包增加 Sponsor 按钮的工具包。下面将详细介绍如何使用 sponsorama。
安装
安装 sponsorama 很简单，只需要运行以下命令即可：
npm install sponsorama
使用
在使用 sponsorama 之前，需要先在 GitHub 上设置 Sponsor。设置 Sponsor 的具体步骤可以参考 GitHub 官网。
在设置 Sponsor 成功之后，我们可以跟随下面的步骤来使用 sponsorama：
- 在 npm 包的根目录下运行以下命令行：
npx sponsorama
- 在结果中选择需要操作的文件（package.json），并输入你的 GitHub 用户名和相关配置信息：
Enter the name of the file to edit (package.json):
? Enter your GitHub username [your-github-username]:
? Sponsor link ('default' for 'https://github.com/sponsors') [default]:
? Sponsor button label [💜 Sponsor]: - 修改完成后保存文件，即可在你的 npm 包中增加 Sponsor 按钮。
其中：
- 用户名是用于将 Sponsor 现金链接到您的个人资料页面的账户
- Sponsor 链接是一个指向 “Sponsor” 现金页面的链接（默认情况下，此链接使用 https://github.com/sponsors）
- Sponsor 按钮标签是您希望在 Readme 和其它地方使用的文本
示例代码
下面是一个完整的示例代码：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- ---- - ----------------
-- ----------------
----- -------- - ----------------------- ----------------
-- --------
----- -------- - -----------------------
----- ---- - ----------
----- ----- - --- ---------
------ -- -- -
--- -
----- -------------------- --------- ----- -------
---------------------
- ----- ------- -
---------------------
-
-----这个代码可以运行在服务器上，实现自动增加 Sponsor 按钮的功能，免去手动操作的麻烦。
总结
本文介绍了一款用于增加 Sponsor 按钮的 npm 包 sponsorama 的使用方法，并提供了示例代码。使用此工具包可以帮助开源维护者获取赞助，并方便赞助者进行赞助操作。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006709f8ccae46eb111f05b