#moonbit: import: []

#xingwangzhe/license_checker

#项目简介

#Project Introduction

#功能 / Features

• 自动检测 / Auto Detection: 自动检测项目中的 moon.mod.json 文件并提取许可证信息
• 多格式输出 / Multiple Output Formats: 支持 JSON 和 TXT 两种报告格式，可输出到文件或标准输出
• 原生二进制 / Native Binaries: 提供多平台预编译二进制包（Linux、macOS、Windows）
• 灵活部署 / Flexible Deployment: 支持作为依赖库或全局 CLI 工具安装

#安装 / Installation

#方式 1: 全局 CLI 工具 / Method 1: Global CLI Tool

moon install xingwangzhe/license_checker/cmd/license-checker

license-checker --format json --output licenses.json [input-path]

#方式 2: 作为项目依赖 / Method 2: As Project Dependency

moon add xingwangzhe/license_checker

import "xingwangzhe/license_checker"

#方式 3: 预编译二进制 / Method 3: Prebuilt Binaries

#使用方法 / Usage

#开发模式 / Development Mode

moon build
moon run ./cmd/license-checker -- --format json --output licenses.json [input-path | packages.json]

#原生二进制模式 / Native Binary Mode

moon build --target native --release
./target/native/release/build/cmd/license-checker/license-checker.exe \
  --format json --output licenses.json [input-path | packages.json]

#命令行参数 / Command Line Arguments

• --format <format>: 输出格式，支持 json 或 txt（默认: json）
• --format <format>: Output format, json or txt (default: json).
• --output <path>: 输出文件路径（可选；不指定则输出到标准输出）
• --output <path>: Output file path (optional; omit to print to stdout).
• <input>: 输入路径或 packages.json 文件（可选；默认扫描 .mooncakes 或当前目录 .）
• <input>: Input path or packages.json (optional; defaults to .mooncakes or current directory .).

#示例 / Examples

# 生成 JSON 报告到文件
# Generate a JSON report to a file
license-checker.exe --format json --output licenses.json

# 生成 TXT 报告到标准输出
# Generate a TXT report to stdout
license-checker.exe --format txt

# 扫描指定目录
# Scan a specific directory
license-checker.exe --format json .mooncakes

# 从 packages.json 读取包信息
# Read package info from packages.json
license-checker.exe --format json target/wasm-gc/release/check/all_pkgs.json

#输出格式 / Output Format

#JSON 格式 / JSON Format

{
  "packages": [
    {
      "root": "package-name",
      "rel": "path/to/package",
      "artifact": "/abs/path",
      "moonmod": "path/to/moon.mod.json",
      "license": "MIT"
    }
  ],
  "summary": {
    "total": 10,
    "unknown_license": 2
  }
}

#TXT 格式 / TXT Format

rootrellicensemoonmod
pkg-aMITpath/to/moon.mod.json
pkg-bUNKNOWN-

#版本历史 / Version History

#更新日志 / Changelog

#v0.2.1

• ✨ 更新为 MoonBit 0.8.0 兼容版本
• ✨ Update for MoonBit 0.8.0 compatibility
• 🔧 迁移 moon.pkg.json 到新的 moon.pkg DSL 配置格式
• 🔧 Migrate from moon.pkg.json to the new moon.pkg DSL
• 📦 支持原生二进制构建与分发（moon build --target native --release）
• 📦 Support native binary build and distribution (moon build --target native --release)
• 📝 完善文档与使用说明
• 📝 Improve docs and usage notes

#v0.1.3

• 🐛 修复许可证解析的边界情况
• 🐛 Fix edge cases in license parsing
• 📚 改进错误提示信息
• 📚 Improve error messages

#v0.1.0

• ✅ 初始功能完成：自动检测 moon.mod.json、JSON/TXT 输出、灵活参数解析
• ✅ Initial features: detect moon.mod.json, JSON/TXT output, flexible args

#许可证 / License

#贡献 / Contributing