npm 包 mos-plugin-license 使用教程

在前端项目开发中，常常需要使用第三方依赖包。然而，这些依赖包往往会涉及到各种不同的开源协议。为了保证项目的合法性，在使用这些依赖包时，我们需要了解它们所使用的开源协议，并且确保自己的项目也符合相应的协议要求。而 mos-plugin-license 就是一个能够帮助我们对项目中的依赖包进行许可证检查的工具。

安装

mos-plugin-license 是一个 npm 包，可以通过 npm 进行安装。打开终端，执行以下命令即可：

npm install --save-dev mos-plugin-license

使用

mos-plugin-license 与 Mos 工具集搭配使用，下面介绍如何在 Mos 中使用该插件进行许可证检查。

配置文件

首先，在项目根目录下创建一个 .mos.yml 文件，用于配置 Mos 的相关信息。在该文件中加入以下内容：

plugins:
  - mos-plugin-license

这样，Mos 就会加载并启用 mos-plugin-license 插件。

检查许可证

在配置好 .mos.yml 文件后，就可以使用 Mos 对项目中的依赖包进行许可证检查了。在终端中执行以下命令：

npx mos check license

Mos 将会扫描项目中的所有依赖包，并输出检查结果。如果有依赖包的许可证不符合要求，将会给出相应的警告或错误信息。

指定许可证

有时候，在项目中使用的依赖包所使用的许可证可能与自己项目的许可证不兼容。这时，我们可以使用 Mos 工具集提供的 license 命令来指定许可证。

例如，要指定 lodash 依赖包的许可证为 MIT 许可证，可以在终端中执行以下命令：

npx mos license lodash@4.17.21 MIT

这样，Mos 就会将 lodash 依赖包的许可证替换为 MIT 许可证。

示例代码

下面是一个示例代码，用于演示如何使用 mos-plugin-license 进行许可证检查及许可证指定。

// index.js

const _ = require('lodash');

console.log(_.add(1, 2));

在项目根目录下创建一个 .mos.yml 文件，其中添加 mos-plugin-license 的配置信息。

打开终端，进入项目根目录，执行以下命令：

npx mos check license

此时，Mos 会扫描项目中的依赖包，并输出检查结果。如果依赖包的许可证都符合要求，则会输出类似以下内容：

Checking licenses...
- All dependencies have compatible licenses

如果依赖包的许可证不符合要求，则会输出相应的警告或错误信息。

接着，在终端中执行以下命令，指定 lodash 依赖包的许可证为 MIT 许可证：

npx mos license lodash@4.17.21 MIT

此时，Mos 将会将 lodash 依赖包的许可证替换为 MIT 许可证。

最后，在终端中执行以下命令，再次进行许可证检查：

npx mos check license

此时，Mos 将会再次扫描项目中的所有依赖包，并输出检查结果。如果依赖包的许可证都符合要求，则会输出类似以下内容：

Checking licenses...
- All dependencies have compatible licenses

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/42381