【iOS】ライセンス表示ライブラリ「LicensePlist」を使ってみた

はじめに

個人アプリにライセンス表示をしたく、有名なライセンス表示ライブラリを使ってみました。

手順

導入手順はGithubのページに丁寧に書かれておりますが、それでも少し詰まったのでメモしておきます。

1. LicensePlistのインストール

• RecommendedのCocoaPodsを使う場合
  Podfileにpod 'LicensePlist'を追加して、pod installする

• Also RecommendedのHomebrewを使う場合
  ターミナルにてbrew install mono0926/license-plist/license-plistする
  だけですが、
  私の場合（環境の問題で）は、Error: Cannot install under Rosetta 2 in ARM default prefix (/opt/homebrew)!と怒られたので、
  arch -arm64 brew install mono0926/license-plist/license-plist
  とarch -arm64を付けて無事インストールできました。

2. LicensePlistの生成

今回対象のアプリはCocoaPodsでライブラリ管理を行なっており、ディレクトリにPodsがあるので
対象アプリに移動してlicense-plistを実行するだけで
com.mono0926.LicensePlist.Outputというディレクトリが自動生成されました。

3. SettingBundleの生成

Setting Bunndleそのものがなかったので、アプリのディレクトリ直下に新規追加します。

新規追加後はこのような状態ですが、

そこにcom.mono0926.LicensePlistとcom.mono0926.LicensePlist.plistを自動生成されたディレクトリから移動させます。

４. Root.plistの修正

デフォルトはこんな感じ

そのまま表示するとこんな感じ

なので、修正します
Root.plistを右クリックでOpen As->Source Codeで表示して👇のように修正します

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>PreferenceSpecifiers</key>
        <array>
            <dict>
                <key>Type</key>
                <string>PSChildPaneSpecifier</string>
                <key>Title</key>
                <string>Licenses</string>
                <key>File</key>
                <string>com.mono0926.LicensePlist</string>
            </dict>
        </array>
        <key>StringsTable</key>
        <string>Root</string>
    </dict>
</plist>

Property Listで表示するとこんな感じに

これで想定通りライセンスが表示されました👏

5. ビルド時にLicensePlistの更新がされるようにする

Build PhasesのNew Run Script Phaseを追加して下記内容（LicensPlist参照)をコピペする

• CocoaPodsを使った場合

if [ $CONFIGURATION = "Debug" ]; then
${PODS_ROOT}/LicensePlist/license-plist --output-path $PRODUCT_NAME/Settings.bundle --github-token YOUR_GITHUB_TOKEN
fi

• Homebrewを使った場合

if [ $CONFIGURATION = "Debug" ]; then
/usr/local/bin/license-plist --output-path $PRODUCT_NAME/Settings.bundle --github-token YOUR_GITHUB_TOKEN
fi

しかし、私の場合は、/usr/local/binではなく/opt/homebrew/binでしたが。

それと、Setting.bundleが直下にない場合は、$PRODUCT_NAME/〇〇/Settings.bundleとすること。

これで準備完了。

ビルドしたらLicensePlistの情報が最新に更新されました👏

感想

Homebrewを使うとLicesePlist自体のライセンス表示がされないので、CocoaPodsで入れて生成した方が良いのだろうなと思いました。

参考