核心功能
wip-license-guard 是一款面向个人/组织自有代码仓库的许可证合规自动化工具,专注于解决开源项目常见的许可证管理痛点:
主要能力
- 版权头合规检查:遍历源码文件,验证版权声明格式正确性
- 双许可证支持:专为 MIT/AGPLv3 双许可证模式设计,确保 LICENSE 文件和声明块完整
- README 许可证章节管理:扫描、预览并标准化多仓库的 README 许可证声明
- 自动修复:
--fix模式自动修正不合规项,无需手动逐文件编辑
CLI 工作流
1. init - 交互式或标准模式初始化配置
2. check - 审计并可选自动修复
3. readme-license - 专门处理文档许可证章节(支持 audit/dry-run/fix 三模式)
显著优点
- 批量处理能力:支持单仓库或整个目录的多仓库操作
- 智能区分:自动识别子工具 README 并移除不当许可证声明
- 零配置快速启动:
--from-standard直接应用 WIP Computer 组织规范
局限性与注意事项
- 范围限制:仅针对"自有仓库"设计,不处理第三方依赖的许可证合规(非 SCA 工具)
- Node 依赖:需要 Node.js 和 Git 环境
- 预设模板:高度绑定 MIT/AGPL 双许可模式,其他许可证组合需自定义配置
- 无 IDE 集成:纯 CLI 工具,无编辑器插件支持
适合人群
- 维护多仓库的开源组织/个人开发者
- 采用 MIT/AGPL 双许可策略的项目(如 WIP Computer 生态)
- 需要在发布前批量标准化许可证声明的维护者
常规风险
- 自动修复会修改源文件和 README,建议先使用
--dry-run预览 - 双许可证声明的强制替换可能覆盖自定义措辞,需确认是否符合项目意图
- 依赖 Node/npm 供应链,需关注包来源可信度