Repolode
mikepenz

mikepenz/AboutLibraries

一个 Gradle 插件加 Compose UI 库,在构建时收集项目依赖及许可证,并在 Android 与多平台应用中展示。

Star
4,493
Fork
608
未关闭 Issue
6
最近提交
5天前

这是什么?

AboutLibraries 会在 Gradle 构建时收集项目的全部依赖及其许可证,生成一份元数据文件,覆盖 Kotlin Multiplatform 的各个目标平台。应用运行时直接读取生成好的 aboutlibraries.json,无需在运行时扫描依赖。

项目提供 Material 2 和 Material 3 的 Compose UI 模块,并有核心模块用于以代码方式读取数据。支持 Android、JVM 桌面、iOS、原生、JS 和 Wasm 等平台,界面可通过变体、密度、详情模式及自定义列表项进行定制。

此外还支持 CSV 与文本导出、合规报告,并提供严格模式,遇到不允许的许可证时可使构建失败;也能展示依赖项目的资助信息。

核心功能

  • 01在 Gradle 构建时收集依赖与许可证元数据
  • 02提供 Material 2 和 Material 3 的 Compose UI 模块
  • 03覆盖 Android、桌面、iOS、Web 与 Wear 等平台
  • 04支持 CSV、文本导出及合规报告
  • 05严格模式可在使用不允许的许可证时使构建失败
  • 06可自定义页眉、页脚和列表项

适用场景

  • 为使用 Compose 构建的 Android 应用添加开源许可证页面
  • 在 Kotlin Multiplatform 应用中共享许可证界面
  • 生成用于合规审查的许可证报告
  • 在 CI 构建中强制执行允许的许可证列表

快速上手

  1. 1

    在应用的构建文件中应用 Gradle 插件

  2. 2

    添加与你的 Material 版本匹配的 Compose UI 模块

  3. 3

    加载生成的数据,并使用 LibrariesContainer 显示

使用前须知

  • 获取远程许可证或资助信息需要 GitHub API 令牌。
  • 除非使用 Android 版插件或手动运行导出任务,否则 Gradle 插件不会自动生成元数据。

收录于专题

标签

#android#compose#kotlin-multiplatform#gradle#licenses#compliance#open-source#aboutlibraries#android-development#android-library

常见问题

AboutLibraries 是什么?
一个 Gradle 插件加 Compose UI 库,在构建时收集项目依赖及许可证,并在 Android 与多平台应用中展示。 AboutLibraries 会在 Gradle 构建时收集项目的全部依赖及其许可证,生成一份元数据文件,覆盖 Kotlin Multiplatform 的各个目标平台。应用运行时直接读取生成好的 aboutlibraries.json,无需在运行时扫描依赖。
AboutLibraries 可以免费使用吗?用的什么许可证?
AboutLibraries 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
AboutLibraries 还在维护吗?
活跃维护中。AboutLibraries 最近一次提交是在 2026年11月2日。
AboutLibraries 适合用来做什么?
为使用 Compose 构建的 Android 应用添加开源许可证页面 在 Kotlin Multiplatform 应用中共享许可证界面 生成用于合规审查的许可证报告 在 CI 构建中强制执行允许的许可证列表
AboutLibraries 怎么安装和运行?
在应用的构建文件中应用 Gradle 插件 添加与你的 Material 版本匹配的 Compose UI 模块 加载生成的数据,并使用 LibrariesContainer 显示
在哪里获取 AboutLibraries?
源代码和安装说明在 GitHub 上:https://github.com/mikepenz/AboutLibraries

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目