Licensee.js 项目使用教程

Licensee.js 项目使用教程

licensee.jscheck dependency licenses against rules项目地址:https://gitcode.com/gh_mirrors/li/licensee.js

1. 项目的目录结构及介绍

licensee.js/
├── github/
│   └── workflows/
├── tests/
├── .gitignore
├── licensee.json
├── LICENSE
├── README.md
├── index.js
└── package.json

• github/workflows/: 包含GitHub Actions的工作流配置文件。
• tests/: 包含项目的测试文件。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• licensee.json: 项目的配置文件，用于定义许可规则和包的允许列表。
• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍和使用说明文档。
• index.js: 项目的入口文件。
• package.json: 项目的npm配置文件，包含项目的依赖、脚本等信息。

2. 项目的启动文件介绍

index.js

index.js 是项目的入口文件，负责初始化和执行项目的核心逻辑。它导出了一个异步函数，接受三个参数：

1. 配置对象: 与 licensee.json 文件中的配置相同。
2. 包的路径: 要检查的包的路径。
3. 错误优先的回调函数: 返回一个依赖项对象数组。

3. 项目的配置文件介绍

licensee.json

licensee.json 是项目的配置文件，用于定义许可规则和包的允许列表。以下是一个示例配置：

{
  "licenses": [
    {
      "spdx": [
        "MIT",
        "BSD-2-Clause",
        "BSD-3-Clause",
        "Apache-2.0"
      ]
    }
  ],
  "author": "x"
}

• licenses: 定义允许的许可证列表，使用SPDX标识符。
• author: 忽略所有作者名称、电子邮件地址或URL中包含 x 的包。所有忽略规则不区分大小写。

使用方法

1. 全局安装:

   npm install --global licensee
   cd your-package
   licensee --init
   licensee
   

2. 作为开发依赖安装:

   cd your-package
   npm install --save-dev licensee
   

3. 添加到npm脚本:

   {
     "scripts": {
       "posttest": "licensee"
     }
   }
   

4. 仅检查生产依赖:

   {
     "scripts": {
       "posttest": "licensee --production"
     }
   }
   

licensee.jscheck dependency licenses against rules项目地址:https://gitcode.com/gh_mirrors/li/licensee.js