Repolode
mikepenz

mikepenz/AboutLibraries

GradleプラグインとCompose UIライブラリを使い、ビルド時にプロジェクトの依存関係ライセンスを収集して、Androidやマルチプラットフォームアプリに表示できます。

スター
4,492
フォーク
609
未解決の Issue
6
最終コミット
13 時間前

これは何?

AboutLibrariesは、Kotlin Multiplatformのターゲットも含め、Gradleプロジェクトのすべての依存関係とライセンスを列挙したメタデータファイルを生成します。収集処理はビルド時に実行されるため、アプリは実行時に依存関係をスキャンするのではなく、事前生成されたaboutlibraries.jsonを読み込みます。

このメタデータをもとに、Material 2とMaterial 3向けのCompose UIモジュールに加え、データをプログラムから読み取るためのcoreモジュールを提供します。Android、JVM desktop、iOS、native、JS、Wasmがサポートされており、variant、density、detail mode、カスタムrow slotを使ってUIをカスタマイズできます。

さらに、CSVおよびテキスト形式でのエクスポート、コンプライアンスレポート、許可されていないライセンスがある場合にビルドを失敗させるstrict mode、依存関係の資金提供情報を表示するオプションも利用できます。

主な機能

  • 01Gradleのビルド時に依存関係とライセンスのメタデータを収集
  • 02Material 2およびMaterial 3向けのCompose UIモジュール
  • 03Android、desktop、iOS、web、Wearの各ターゲットに対応
  • 04CSV・テキスト形式でのエクスポートとコンプライアンスレポート
  • 05許可されていないライセンスがある場合にビルドを失敗させるstrict mode
  • 06ヘッダー、フッター、ライブラリ行のslotをカスタマイズ可能

ユースケース

  • 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は、Kotlin Multiplatformのターゲットも含め、Gradleプロジェクトのすべての依存関係とライセンスを列挙したメタデータファイルを生成します。収集処理はビルド時に実行されるため、アプリは実行時に依存関係をスキャンするのではなく、事前生成されたaboutlibraries.jsonを読み込みます。
AboutLibraries は無料で使えますか?ライセンスは?
AboutLibraries は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
AboutLibraries は今もメンテナンスされていますか?
活発にメンテナンス中。AboutLibraries の最終コミットは 2026年11月7日 です。
AboutLibraries は何に使えますか?
Composeで構築したAndroidアプリにオープンソースライセンス画面を追加する Kotlin Multiplatformアプリでライセンス画面を共有する コンプライアンス審査用のライセンスレポートを生成する CIビルドで許可ライセンスのリストを適用する
AboutLibraries のインストール方法は?
アプリのビルドファイルでGradleプラグインを適用します Materialのバージョンに合ったCompose UIモジュールを追加します 生成されたデータを読み込み、LibrariesContainerで表示します
AboutLibraries はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/mikepenz/AboutLibraries

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト