Angularアプリケーションの開発において、3rdpartylicenses.txtというファイルを聞いたことがあるでしょうか。このファイルは、アプリケーションで使用しているサードパーティライブラリのライセンス情報をまとめたものです。
この記事では『3rdpartylicenses.txt』について、以下の内容をわかりやすく解説します。
- Angularの3rdpartylicenses.txtとは
- 3rdpartylicenses.txtの生成方法
- 3rdpartylicenses.txtの表示方法
Angularの3rdpartylicenses.txtとは
3rdpartylicenses.txt
は、Angularで作成されたアプリケーションが依存しているサードパーティライブラリのライセンス情報をまとめたテキストファイルです。このファイルには、アプリケーションが利用しているすべてのライブラリ名とライセンス情報が記載されます。
3rdpartylicenses.txt
の特徴を以下に示します。
3rdpartylicenses.txtの特徴
- 自動生成されるファイルである
- Angular CLIを使用してビルドを行う際、自動的に生成されます。
- ライブラリ名とライセンス情報が記載されている
3rdpartylicenses.txt
には、アプリケーションが使用しているライブラリ名とそのライセンス情報がまとめられています。
例えば、アプリケーションがtslib
とzone.js
というライブラリを使っている場合、3rdpartylicenses.txt
には、以下のように表示されます。
tslib
0BSD
Copyright (c) Microsoft Corporation.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
zone.js
MIT
The MIT License
Copyright (c) 2010-2023 Google LLC. https://angular.io/license
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
angular.ioの3rdpartylicenses.txt
一例として、Angular公式サイト(https://angular.io)の3rdpartylicenses.txt
のリンクを以下に示します。
上記のリンクを見ると、angular.ioが使用しているライブラリのライセンス情報が分かります。
3rdpartylicenses.txtの生成方法
3rdpartylicenses.txt
を生成する方法は主に以下の3つあります。
- 方法1:
ng build --configuration production
を使用する - 方法2:
ng build --extract-licenses=true
を使用する - 方法3:
angular.json
で設定を行う
これから上記の方法について、詳しく解説します。
方法1: ng build --configuration productionを使用する
Angularアプリを本番環境(Production)向けにビルドする際には、以下のコマンドを実行します。このコマンドを実行すると、dist/[プロジェクト名]ディレクトリ
に3rdpartylicenses.txt
が生成されます。
ng build --configuration production
# 短縮形でも可
ng build -c production
Angular CLI バージョン12以降では、--prod
フラグは廃止されたので、ng build --prod
は用いることができません。そのため、--configuration production
または短縮形の -c production
を使用する必要があります。
以下に示すように、デフォルトのビルド設定がproduction
に設定されている場合(angular.json
ファイルのprojects.xxx.architect.build
の箇所に記載されているdefaultConfiguration
オプションがproduction
の場合)、ng build
コマンド単独でも、dist/[プロジェクト名]ディレクトリ
に3rdpartylicenses.txt
が生成されます。
{
"projects": {
"your-project-name": {
"architect": {
"build": {
"defaultConfiguration": "production"
}
}
}
}
}
この状態でアプリをデプロイするだけで、[URL]/3rdpartylicenses.txt
のURLでライセンス表示を公開することができます。
方法2: ng build --extract-licenses=trueを使用する
本番環境以外でビルドする際も、以下のコマンドを使用すると、dist/[プロジェクト名]ディレクトリ
に3rdpartylicenses.txt
が生成されます。
ng build --extract-licenses=true
このオプションを使うことで、特定の環境に依存せずライセンス情報を抽出できます。
方法3: angular.jsonで設定を行う
ng build
時に毎回オプションを指定するのが大変な場合、angular.json
ファイルに設定を追加することでデフォルトの挙動を変更できます。
angular.json
ファイルの以下の箇所(projects.xxx.architect.build.options
の箇所)にextractLicenses
オプションを指定することで、ng build
を実行するだけで、常にdist/[プロジェクト名]ディレクトリ
に3rdpartylicenses.txt
が生成されます。
{
"projects": {
"your-project-name": {
"architect": {
"build": {
"options": {
"extractLicenses": true
}
}
}
}
}
}
3rdpartylicenses.txtの表示方法
ビルド後、dist/[プロジェクト名]ディレクトリ
に生成される3rdpartylicenses.txt
を確認する手順を以下に示します。
1. ビルドを実行する
以下のコマンドを実行して、ビルドを行います。
ng build --configuration production
# 短縮形でも可
ng build -c production
2. ファイルを探す
dist/[プロジェクト名]ディレクトリ
内に3rdpartylicenses.txt
があります。
3. テキストエディタで開く
好きなエディタを使用して3rdpartylicenses.txt
を開くと、サードパーティライブラリの詳細が確認できます。