前言
随着 JavaScript 的普及， npm 成为了前端开发中必不可少的工具。npm 上有海量的开源包，开发者可以直接使用这些包来快速搭建前端应用程序。但是，在使用这些包的过程中，我们还需要关注开源许可协议的问题。如何确保在使用他人的代码时不会侵犯他人的权益呢？这就需要我们在自己的项目中包含许可协议，使开源的代码得到合理地利用和扩展。
add-license 是一个 npm 包，用于将许可协议添加到 npm 包中。本文将介绍如何使用 add-license 将许可协议添加到你的 npm 包中。
安装
通过以下命令来安装 add-license：
$ npm install -g add-license
使用 add-license
初始化一个新的 npm 包
假设你要新建一个 npm 包，并为其加上许可协议，可以按照以下步骤来初始化：
- 在本地新建一个项目：
$ mkdir my-package && cd my-package - 初始化项目：
$ npm init -y - 安装 add-license：
$ npm install --save-dev add-license
现在，我们已经在本地新建了一个项目 my-package，并初始化了一个 package.json 文件。接下来，我们可以使用 add-license 给新建的项目加上许可协议。
为现有的 npm 包添加许可协议
对于已经存在的 npm 包，可以按照以下步骤为其添加许可协议：
- 安装 add-license：
$ npm install --save-dev add-license - 打开 package.json 文件，找到
license字段，确认其为UNLICENSED。 - 运行
$ npx add-license -c LicenseName，其中 LicenseName 可以替换成你使用的许可协议名。add-license 将提示你选择要使用的许可协议。 - 接着，add-license 将询问项目的作者，许可证类型 (single、dual or multi)，授权给许可证的人 (everyone or specific) 等信息。
现在，我们已经将许可协议成功添加到我们的项目中了。许可协议将会以 LICENSE 或 LICENSE.txt 未文件名，存在于项目的根目录中。
在 package.json 中添加许可证信息
add-license 还可以帮助我们将许可证信息添加到 package.json 文件中，方便其他开发者查看该项目的许可证信息。
在 package.json 文件中，我们添加如下 license 字段：
-- -------------------- ---- -------
-
------- -------------
---------- --------
-------------- --- ------- -------------
------- -----------
---------- -
------- ----- -------- -- ---- ----------- -- ---- --
--
---------- --------------
------------------ -
-------------- --------
-
-示例
我们可以在 examples 文件夹中创建一个示例项目，并添加许可协议。
-- -------------------- ---- ------- - - -------- -------- - ----- -------- -- -- -------- - --- ---- -- - -- ----------- - --- ------- ---------- ----------- - -- ------------------------- - --- ----------- -- ---
在初始化完成后，我们可以在 examples 文件夹中看到生成了一个 LICENSE 文件，并且在 package.json 文件中添加了如下描述许可协议信息的字段：
{
"license": "MIT"
}总结
在使用开源代码的过程中，我们应该关注开源许可协议，使用许可协议能够在保证代码开源的同时，保护代码作者的权益。add-license 是一个方便的 npm 包，我们可以利用它来将许可协议添加到我们的 npm 包中，方便其他开发者查看我们的许可协议信息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005577181e8991b448d4708