[小ネタ]Angularで利用しているパッケージのライセンス情報を出力する

2021.04.07

こんにちは!DA(データアナリティクス)事業本部 インテグレーション部の大高です。

Angularで作成したプロジェクトでは、OSSのパッケージを利用することがあると思います。OSSには様々なライセンス形態が存在し、MITライセンスでは下記のように定められています。

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

このため、下記コマンドでのプロダクションビルド時には3rdpartylicenses.txtというファイルが自動的に出力されるようになっています。

$ ng build --prod

この3rdpartylicenses.txtを「UI上に表示したい」という場合には、プロダクションビルド以外に何かしら出力する必要があるので、その方法を調べて試してみました。

明示的な出力方法

調べたところng buildコマンドには--extract-licensesというオプションが存在し、このオプションにtrueを指定すれば良いようです。

$ ng build --extract-licenses=true

また、ng buildのオプションで指定可能なので、angular.jsonファイルでも指定することが可能です。以下のようにprojects.xxx.architect.build.optionsの箇所にextractLicensesを指定することで、ng build時にコマンドでオプションを指定しなくてもよくなります。

angular.json

(略)
      "architect": {
        "build": {
          "builder": "@angular-devkit/build-angular:browser",
          "options": {
            "extractLicenses": true,
(略)

なお、ng serve時に出力できないかなと思ったのですが、こちらには該当するオプションも無く、無理なようです。

出力してみる

今回はビルドコマンドでのオプション指定で出力してみました。

$ ng build --extract-licenses=true

ビルド後に、以下のようにライセンス情報が出力されます。

dist/xxx/3rdpartylicenses.txt

(略)
zone.js
MIT
The MIT License

Copyright (c) 2010-2020 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で利用パッケージのライセンス情報を出力してみました。

通常はあまり気にする必要がないかと思いますが、別途UI上にライセンス情報を表示したいというようなケースでは、出力した3rdpartylicenses.txtを利用してライセンス情報を表示させることができるかと思います。

どなたかのお役に立てば幸いです。それでは!