Licensee.js 项目使用教程

Licensee.js 项目使用教程

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

Licensee.js 项目的目录结构如下：

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

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于自动化测试和部署。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的开源许可证文件，本项目使用 Apache-2.0 许可证。
• README.md: 项目的说明文档，包含项目的基本信息、安装和使用方法。
• index.js: 项目的入口文件，负责初始化和执行主要的逻辑。
• licensee.json: 项目的配置文件，用于定义许可规则和包的允许列表。
• package.json: 项目的 npm 配置文件，包含项目的依赖、脚本等信息。

2. 项目的启动文件介绍

项目的启动文件是 index.js，该文件是项目的入口点，负责初始化和执行主要的逻辑。以下是 index.js 的基本结构和功能介绍：

// index.js
const licensee = require('./licensee');

// 初始化配置
const config = require('./licensee.json');

// 执行许可检查
licensee(config, (err, results) => {
    if (err) {
        console.error('License check failed:', err);
        process.exit(1);
    }
    console.log('License check passed:', results);
});

功能介绍

• 引入依赖: 通过 require 引入 licensee 模块。
• 加载配置: 从 licensee.json 文件中加载配置。
• 执行许可检查: 调用 licensee 函数，传入配置并执行许可检查。检查结果通过回调函数返回，如果检查失败则输出错误信息并退出程序，否则输出检查通过的信息。

3. 项目的配置文件介绍

项目的配置文件是 licensee.json，该文件用于定义许可规则和包的允许列表。以下是 licensee.json 的基本结构和配置项介绍：

{
    "licenses": [
        {
            "spdx": [
                "MIT",
                "BSD-2-Clause",
                "BSD-3-Clause",
                "Apache-2.0"
            ]
        }
    ],
    "packages": [
        {
            "optimist": "<=0.6.1"
        }
    ],
    "corrections": false,
    "ignore": [
        {
            "scope": "kemitchell"
        },
        {
            "prefix": "commonform-"
        },
        {
            "author": "Kyle E. Mitchell"
        }
    ]
}

配置项介绍

• licenses: 定义允许的许可证列表，支持 SPDX 标识符和蓝橡树许可证评级。
• packages: 定义包的允许列表，指定包名和版本范围。
• corrections: 是否启用社区修正，用于修正 npm 包的许可证元数据。
• ignore: 定义忽略规则，可以按包的作用域、前缀或作者名称忽略包。

通过以上配置，Licensee.js 可以灵活地检查和管理项目的依赖许可证，确保符合预定义的许可规则。