Repository files navigation

LicensePlist is a command-line tool that automatically generates a Plist of all your dependencies, including files added manually(specified byYAML config file) or usingCarthage orCocoaPods. All these licenses then show up in the Settings app.

App Setting Root	License List	License Detail

Warning
SPM(Swift Package Manager) are not supported.

pod 'LicensePlist'# Installation path: `${PODS_ROOT}/LicensePlist/license-plist`

brew install licenseplist

mint run mono0926/LicensePlist

In Project Settings, on the tab "Package Dependencies", click "+" and addhttps://github.com/mono0926/LicensePlist.

Click "Add Package" without selecting any package products.

Download fromReleases, then copy to/usr/local/bin/license-plist etc.

Or you can also download the latest binary and install it with a one-liner.

curl -fsSL https://raw.githubusercontent.com/mono0926/LicensePlist/master/install.sh| sh

Clone the master branch of the repository, then runmake install.

git clone https://github.com/mono0926/LicensePlist.gitmake install

1. When you are in the directory that contains yourCartfile orPods, simply executelicense-plist.
2. com.mono0926.LicensePlist.Output directory will be generated.
3. Move the files in the output directory into your app'sSettings.bundle.
   • Settings.bundle's sample is here
   • The point is tospecifycom.mono0926.LicensePlist as license list file on yourRoot.plist.

Settings.bundle├── Root.plist├── com.mono0926.LicensePlist│   ├── APIKit.plist│   ├── Alamofire.plist│   └── EditDistance.plist├── com.mono0926.LicensePlist.plist├── en.lproj│   └── Root.strings└── ja.lproj    └── Root.strings

You can see options bylicense-plist --help.

• Default:Cartfile

• Default:Mintfile

• Default:nestfile.yaml

• Default:Pods

• Default:Package.swift
• LicensePlist tries to findYourProjectName.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved andYourProjectName.xcworkspace/xcshareddata/swiftpm/Package.resolved, then uses new one.

• Support for multiplePackage.swift
• Example:license-plist --package-paths /path/to/package1/Package.swift /path/to/package2/Package.swift

• Default: None.
• The directory with cloned Swift package sources. If specifiedLicensePlist uses cloned files instead of GitHub API. For more information, see parameter-clonedSourcePackagesDirPath ofxcodebuild.
• Example:license-plist --package-sources-path ./SourcePackages

• Default:"*.xcodeproj"
• By specifiying the path to the.xcodeprojLicensePlist will attempt to load thePackage.resolved from that Xcode project. If you specifysomedir/*.xcodeproj thenLicensePlist will load from the firstxcodeproj it finds insomedir.

• Default:"*.xcworkspace"
• By specifying the path to the.xcworkspaceLicensePlist will load thePackage.resolved from that Xcode workspace. If you specifysomedir/*.xcworkspace thenLicensePlist will load from the firstxcworkspace it finds insomedir.
• --xcworkspace-path supersedes any provided--xcodeproj-path.

• Default:com.mono0926.LicensePlist.Output
• Recommended:--output-path YOUR_PRODUCT_DIR/Settings.bundle

• Default: None.
• LicensePlist uses GitHub API, so sometimes API limit errors occur. You can avoid those errors by specifying a GitHub token.
• You can generate a token here
  • repo scope is needed.
• You can also pass the GitHub token via theLICENSE_PLIST_GITHUB_TOKEN environment variable.

• Default:license_plist.yml
• You can specify GitHub libraries(introduced by hand) and excluded libraries
  • Example is here
  • SeeConfiguration for more information

• Default:com.mono0926.LicensePlist
• You can specify output file names instead of default one.

• Default: None.
• If this path is specified, a html acknowledgements file will be generated.
  • Example is here

• Default: None.
• If this path is specified, a markdown acknowledgements file will be generated.
  • Example is here

• Default: None.
• If this path is specified, a csv acknowledgements file will be generated.
  • Example is here

• Default:LICENSE, LICENSE.*.
• License file name variants for cloned Swift packages.
  • Case insensitive.
  • Supports any non-empty path extensions ifFILENAME.* is specified.
  • Used only in combination with--package-sources-path.

• Default: false
• LicensePlist saves latest result summary, so if there are no changes, the program interrupts.
  • In this case,execution time is less than 100ms for the most case, soyou can runLicensePlist atRun Script Phase every time 🎉
• You can run all the way anyway, by using--force flag.

• Default: false
• When the library name isSomeLibrary, by adding--add-version-numbers flag, the name will be changed toSomeLibrary (X.Y.Z).
  • X.Y.Z is parsed from CocoaPods and Cartfile information, and GitHub libraries specified atConfig YAML also support this flag.

• Default: false
• Adds the source of the library to the output if there is one. The source for GitHub and CocoaPods libraries is generated. Manual libraries use the optional source field.

• Default: false
• Only when the files are created or updated, the terminal or the finder opens. By adding--suppress-opening-directory flag, this behavior is suppressed.
• Automatically enabled if--sandbox-mode is specified.

• Default: false
• All licenses are listed on a single page, not separated pages.

• Default: false
• If there is even one package for which a license cannot be found, LicensePlist returns exit code 1.

• By adding the--silence-mode flag, the logger's output will not print.
• The logger's output will be more detailed than the average log level by adding the--verbose flag.
• LicencePlist uses the latter option if you simultaneously set the--silence-mode option and the--verbose option.
• Default: average log level

• The logger's output is printed in monochrome by adding the--no-color flag. If any escape characters in CI/CD log bother you, the--no-color option will help.
• By adding the--color flag, LicensePlist will always print the logger's output in color.
• LicencePlist uses the latter option if you simultaneously set the--no-color option and the--color option.
• If neither option is specified, LicensePlist will look for theNO_COLOR environment variable. If you set theNO_COLOR environment variable to"1", LicensePlist runs without colors.
• Default: auto - LicensePlist decides its color mode depending on the terminal type.

• Default: false
• Enables or disables the "sandbox" mode.
• In the sandbox mode, LicensePlist avoids network requests. That means Swift package licenses can not be fetched with GitHub API. To parse Swift package licenses--package-sources-path must be specified.

Add aRun Script Phase toBuild Phases:

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

Alternatively, if you've installed LicensePlist via CocoaPods the script should look like this:

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

LicensePlist build tool plugins requiresSwift package installation.

Select your target, on the tab "Build Phases", in the section "Run Build Tool Plug-ins", click "+" and addLicensePlistBuildTool.

In the case of using the build tool plugin, define all the settings inlicense_plist.yml at the root of your project.

license_plist.yml example:

options:xcworkspacePath:"*.xcworkspace"prefix:AcknowledgementssinglePage:true

Important: to process Swift Package licenses, the config must include one of the following parameters:

• xcworkspacePath,
• xcodeprojPath,
• packagePaths.

Note:outputPath andpackageSourcesPath config parameters are ignored by the build tool plugin.

See theconfiguration section for more information.

If you need to put license files toSettings.bundle or any other specific place add the following script to build phases:

echo"Will copy acknowledgements"ACKNOWLEDGEMENTS_DIR=${BUILT_PRODUCTS_DIR}/${CONTENTS_FOLDER_PATH}/com.mono0926.LicensePlist.OutputDESTINATION_PATH=${BUILT_PRODUCTS_DIR}/${CONTENTS_FOLDER_PATH}/Settings.bundle/cp -r"${ACKNOWLEDGEMENTS_DIR}"/*"${DESTINATION_PATH}"rm -rf"${ACKNOWLEDGEMENTS_DIR}"

Or in project contextual menu click "AddAcknowledgementsCopyScriptCommand" and select application target to create the build phase automatically.

Build the app. At the first run, Xcode asks a permission to run the plugin. Click "Trust & Enable All"

For unattended use (e.g. on CI), you can disable the package validation dialog by

• individually passing-skipPackagePluginValidation toxcodebuild or
• globally settingdefaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YESfor that user.

Note: This implicitly trusts all Xcode package plugins and bypasses Xcode's package validationdialogs, which has security implications.

LicensePlist command requiresSwift package installation.

In the project contextual menu click "GenerateAcknowledgementsCommand".

The command dialog allows to specifycommand line arguments. Since Xcode doesn't save the arguments for future use, it's recommended to use aconfiguration file.

Click "Run" to run LicensePlist.

Click "Allow Command to Change files". This action provides LicensePlist write access to your project directory.

"Don't ask again" option prevents showing this dialog in the future.

Note:--package-sources-path option andpackageSourcesPath config parameter are ignored by the command plugin.

The main parameters from theOptions can be defined in the configuration file.

All the parameters are optional.

The tool uses the command line value if both the command line and the config specify values for the same attribute.

options:outputPath:"./com.mono0926.LicensePlist.Output"cartfilePath:CartfilemintfilePath:MintfilenestfilePath:nestfile.yamlpodsPath:PodspackagePaths:    -Package.swiftpackageSourcesPath:"./SourcePackages"xcodeprojPath:"*.xcodeproj"xcworkspacePath:"*.xcworkspace"prefix:com.mono0926.LicensePlistgitHubToken:YOUR_GITHUB_TOKENhtmlPath:acknowledgements.htmlmarkdownPath:acknowledgements.mdlicenseFileNames:    -LICENSE    -LICENSE.*force:falseaddVersionNumbers:falsesuppressOpeningDirectory:falsesinglePage:falsefailIfMissingLicense:falseaddSources:falsesandboxMode:false

A GitHub source can be explicitly defined to include the license in the scenario where it can't be inferred from your dependency files.

github:  -owner:mono0926name:LicensePlistversion:1.2.0

If you need to include a license that isn't available on GitHub, you can place the license text in the config file to be included in the output.The license text can also be read from a local file, to keep the config file clean.

License body directly in the config file:

manual:  -source:https://webrtc.googlesource.com/srcname:WebRTCversion:M61body:|-      Copyright (c) 2011, The WebRTC project authors. All rights reserved.      ...      ...      ...

License body in local file:

manual:  -name:"Dummy License File"file:"dummy_license.txt"

Excludes can be defined to exclude matching libraries from the final output.An exclude is a dictionary containing any combination ofname,source,owner, orlicenseType.

When using the dictionary format:

• The exclusion rule is only applied ifall properties match for a dependency. eg,(name: LicensePlist) AND (owner: mono0926)
• Any property can be either a string or a regular expression.

Exclude a package by name:

exclude:  -name:LicensePlist

Exclude packages using a specific license:

exclude:  -licenseType:"Apache 2.0"

Exclude packages using any matching licenses:

exclude:  -licenseType:/BSD/

Exclude packages from a specific github owner:

exclude:  -owner:mycompany

Exclude packages from a specific github owner containing matching licenses:

exclude:  -owner:mycompanylicenseType:/^(?!.*MIT).*$/# this regex excludes packages that do NOT use the MIT license

Exclude a package from a specific github owner and repo:

exclude:  -owner:mycompanyname:private-repo

If a library name is unsuitable for the output bundle, you can explicitly rename it. This can be used when a library name is too vague, or if more human-readable names are needed.

rename:LicensePlist:License Plist# Rename LicensePlist to "License Plist"WebRTC:Web RTC# Rename WebRTC to "Web RTC" (which is faulty, but used for test)

Executeswift package generate-xcodeproj ormake xcode.

• LicensePlist というiOSアプリ利用ライブラリのライセンス一覧生成するツールを作りました – Swift・iOSコラム – Medium
• Swift Package Manager(SwiftPM)で作ったコマンドラインツールをHomebrewに登録する方法 - Qiita

Donations are welcome if you like LicensePlist🤗

• PayPal.Me
  • Transfer commission will be charged (40 yen + 3.6%)
• mono is creating LicensePlist | Patreon
• Amazonギフト券- Eメールタイプ
  • メールアドレス:mono0926@gmail.com
• ほしい物リスト