在开发中，使用外部的 npm 包可以快速提高开发效率，为我们的项目加速进程。然而，我们需要了解这些包所遵守的开源协议，以遵循规定并避免法律纠纷。这时，我们就需要来介绍一个 NPM 包——fast-license。
fast-license 是一个快速获取 NPM 包开源协议的工具。它能够自动识别项目的许可证并以文本格式输出。它是一个非常便捷的工具，为开发者解决了许可证的详细追溯和分析过程。本篇文章将介绍 fast-license 的基本用法和相关细节。
首先，我们来安装 fast-license
通过 NPM 安装 fast-license 十分方便。打开控制台，输入：
npm install fast-license
安装完成之后，我们就可以在项目中使用 fast-license 工具了。使用前，我们先来看看它的基本命令。
了解 fast-license 的基本命令
在使用 fast-license 工具前，我们需要先了解它的几个基本命令。以下是常用的几个命令：
fast-license <package-name>：通过输入包名，可以查看该包的开源协议。fast-license -d <directory>：通过输入目录，可以查看该目录下所有项目的开源协议。fast-license -s：查看当前目录下所有依赖的开源协议和许可证。fast-license -h：获取帮助信息。
以上几个命令基本上可以满足我们的需求。接下来，我们来实际操作一下。
fast-license 的使用
查看单个包的开源协议
使用 fast-license 命令，加上要查看的包名即可。比如，我们要查看 react 的协议，执行下面的命令：
fast-license react
输出结果如下：
-- -------------------- ---- -------
------------------
--- --------------
--- ---------------------------
--- ----------------------
- --- ---------------
--- ---------------------
--- ---------------
------------
--- -------------------
--- -----------------
- --- ------------------
- --- -------------------
--- ----------------
--- ------------------
- --- ---------------
--- -------------------其中，第一个 fast-license@1.0.0 行显示 fast-license 的当前版本和依赖，react@17.0.2 行则显示了 react 包的依赖及其许可证信息。
批量查看目录下所有项目的开源协议
fast-license 支持通过输入目录，批量查看该目录下所有项目的开源协议。使用 -d 命令参数即可，比如：
fast-license -d /Users/me/project/
输出会像这样：
-- -------------------- ---- ------- -------------------------------- --- ------------------ - --- ------- - --- ------------ - --- ------------------------ - - --- ------- - - --- ------------ - --- ----------------------- - - --- ------- - - --- ------------ - ----- ---------------- --- -------------- - --- ------- - --- ------------ - --- --- --- ----------------- --- ------- --- ---
fast-license 递归地进入该目录下的所有项目目录，提取项目名称和各自包的协议信息，并递归输出到控制台。
查看当前目录下所有依赖的开源协议
如果我们需要查看当前目录下所有依赖的开源协议和许可证信息，可以使用 -s 命令参数，比如：
fast-license -s
控制台输出如下所示：
-- -------------------- ---- -------
------------------
--- --------------
--- ---------------------------
--- ----------------------
- --- ---------------
--- ---------------------
--- ---------------
--------------
--- -----------
- --- -------
--- -------
------------
--- -----------
- --- -------
--- -------------------
--- -------fast-license 会递归遍历所有依赖，同时获取依赖的许可证信息。
总结
fast-license 是一个非常容易使用的 NPM 包，它能够帮助我们自动追踪项目所依赖的许可证信息，并且极大地方便了我们遵守开源协议的规定。我们只需要记住简单的命令参数即可。希望这篇文章能够帮助你更好地使用 fast-license，提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600559b181e8991b448d7409