核心功能
wip-license-guard 是一款面向开源项目维护者的许可证合规 CLI 工具,专注于自动化解决代码仓库中的版权与许可证一致性问题。其核心能力涵盖四大场景:
1. 全仓审计 (check):扫描指定路径下所有源文件,验证版权头完整性、LICENSE 文件存在性及内容正确性,支持自动修复模式 (--fix)
2. 双许可模式支持:专为 MIT/AGPLv3 双许可设计,确保代码头块与项目级 LICENSE 文件的法律一致性
3. README 许可标准化 (readme-license):审计、预览 (--dry-run) 及批量修复多仓库的 README 许可证声明区块,智能识别子工具仓库并自动移除冗余声明
4. 交互式初始化 (init):支持从零配置或应用 WIP Computer 组织级默认模板
显著优势
- 精准双许可支持:市面上罕见的原生支持 MIT/AGPL 双许可合规的专用工具,满足 Copyleft 与宽松许可并存的复杂场景
- 批量多仓能力:可一次性处理目录下的多个仓库,适合拥有大量微仓库的组织
- dry-run 安全模式:所有修复操作均可预览,避免误改
- Node.js 生态原生:基于 npm 分发,与 JavaScript/TypeScript 项目工具链无缝集成
潜在局限
- 语言范围限制:版权头检测机制未明确说明对非 JS/TS 语言(如 Python、Go、Rust)的注释语法适配程度
- 许可模板固化:强制绑定 WIP Computer 的双 MIT/AGPL 模板,自定义其他许可组合(如 Apache-2.0)需手动配置
- CLI 独占:无 CI/CD 预设配置(GitHub Action 等),需自行封装
适合人群
- 维护多仓库开源项目的个人开发者或组织
- 采用 MIT/AGPL 双许可策略的项目(如 MongoDB、Elastic 早期模式)
- 需要批量标准化历史仓库许可证声明的 DevOps 团队
常规风险提示
- 法律非专业工具:自动生成的许可文本不构成法律建议,关键项目仍需律师审核
- 误修复风险:
--fix模式可能覆盖手写的特殊许可声明,建议在 CI 中结合--dry-run做门禁检查 - 依赖 Node 运行时:目标环境必须预装 Node.js 与 Git