在前端开发中，我们常常需要引入各种 npm 包来完成项目的功能需求。但是，在使用这些包的时候我们要注意到它们的许可证类型，以便我们遵循其使用限制。为了便捷地了解项目中的 npm 包许可证情况，我们可以使用 npm 包 license-reporter 进行许可证报告的生成。
1. 什么是 license-reporter
license-reporter 是一个 npm 包，可以帮助我们生成项目中 npm 包的许可证报告。在项目中使用 license-reporter，可以帮助我们更好地了解所有引入的 npm 包的许可证信息，以及遵守许可证的使用规则。
2. 安装 license-reporter
使用以下命令安装 license-reporter：
npm install license-reporter --save-dev
安装完成后，在项目的 package.json 文件中，入口文件 scripts 中添加以下命令：
"scripts": {
"license-report": "license-reporter"
}3. 使用 license-reporter
3.1 基本用法
在项目根目录下打开终端，运行以下命令：
npm run license-report
执行以上命令后，会在项目根目录下生成一个名为 license-report.html 的文件。该文件详细展示了项目中使用的 npm 包的许可证信息，包括每个包的名称、版本、许可证类型和许可证 URL。
3.2 过滤无关信息
使用 --ignore-plugins 命令可以忽略掉 package 中指定的依赖包。
npm run license-report -- --ignore-plugins react
上面的示例代码表示忽略掉 package.json 中的 react 包。
3.3 生成输出到 console 中
使用 --output console 命令可以将许可证报告输出到命令行窗口中。
npm run license-report -- --output console
上面的示例代码表示输出许可证报告到控制台。
4. 结语
通过使用 license-reporter 工具，我们能够更好地了解并遵守 npm 包的许可协议规则，从而避免许可证违规的风险。在开发过程中使用，能够使我们对项目所采用的 npm 包有更详细的了解和把控。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f262c333b0ab45f74a8b9ab