在开发过程中，遵守开源协议的规范是非常重要的。 slush-license是一个用来自动添加指定的开源协议的文件（LICENSE、LICENSE.MD、COPYING等等）至项目中的工具。这篇文章将介绍如何使用 slush-license 来添加开源协议。
安装 slush-license
在安装之前，你需要先安装 slush 。
npm install -g slush
随后安装 slush-license:
npm install -g slush-license
使用 slush-license
使用 slush-license，你需要在终端输入：
slush license
这个命令将会建立一个文件夹 license， 并且将协议文件添加到目录中。
配置 slush-license
在运行 slush-license 之前你需要在你的 npm 项目中添加一个配置文件 .slushrc.json 。你可以参考下面的文件：
-
------- ----------
---------- -
--------------------------------------
--
---------- -
------------- ----------------------------------------
------- -----
------------ -- ---- -----
-
-在这个文件中，name 定义了生成的目标文件夹名字。sources 是指定协议模板所在的文件夹（.slushrc.json 在项目根目录下）。options 是一个对象，在这里你可以设置协议文件的创建年份和版权。
示例代码
假设我们要在一个项目中使用 MIT 开源协议，首先建立 .slushrc.json 文件并添加 slush-license 的配置，之后运行命令 slush license 。你可以参考下面的示例代码：
- 安装 slush
npm install -g slush
- 安装 slush-license
npm install -g slush-license
- 编写配置文件
-
------- ----------
---------- -
--------------------------------------
--
---------- -
------------- ----------------------------------------
------- -----
------------ -- ---- -----
-
-- 运行命令生成协议文件
输入以下命令：
slush license
之后进入到项目中，你可以看到新生成了一份 MIT 开源协议文件。这个协议文件将被自动添加至你的项目中。
结论
有了 slush-license，你将会大大减少添加开源协议文件的时间。同时它也能够帮助你更好地遵守开源协议的规范。如果你的开源项目需要添加更多的功能，可以参考 slush 的文档，从而为自己的项目提供更好的支持。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005587581e8991b448d5b1a