依存ライブラリのLICENSEファイルを収集する php-vendor-credits を作りました

TLの@katzchumさんのPostで興味深い話題を見付けました。

Go言語では、バイナリ配布しやすい形態であるという事情もあると思いますが、依存ライブラリのLICENSEを同梱するための、gocredits というツールがあるようでした。

下のリンクが、Songmuさんのオリジナルのgocreditsの紹介エントリです。

ライブラリ管理のファイルをチェックして依存ライブラリを特定し、それぞれのライセンスファイルファイルの情報を標準出力に出力するツールのようです。

これは、練習に丁度良いサイズの課題だと思いました。PHPでは、プログラムを配布するケースは少ないかもしれませんが、Phar形式で配布する時にCREDITSを含めるために使うことは可能なのではないでしょうか。

試作のつもりで作ってみた

Songmu/gocredits のソースも参考にさせていただきましたが、PHP で composer をベースにしているので、独自の事情により設計を考慮すべき点も出てきつつ、最低限の機能を作ってみました。

  • composer.lock に、ローカル環境にインストールしたライブラリが記録されているので、packagesから依存ライブラリの一覧を取得しています。
  • vendorディレクトリが、composer.jsonで変更されている場合が有り得るので、config.vendor-dir項目をチェックする必要がある。
  • LICENSEファイルを探すロジックについては、gocredits のロジックをそのまま使わせてもらいました。

使い方

packagistにも登録しましたので、簡単に試していただけると思います。試してエラーが出たとかありましたら、連絡いただけると嬉しいです。

インストール

$ composer require --dev smeghead/php-vendor-credits

実行する

$ vendor/bin/php-vendor-credits . > CREDITS
$ head -35 CREDITS
psr/container
https://github.com/php-fig/container
----------------------------------------------------------------
The MIT License (MIT)

Copyright (c) 2013-2016 container-interop
Copyright (c) 2016 PHP Framework Interoperability Group

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.

================================================================

symfony/console
https://symfony.com
----------------------------------------------------------------
Copyright (c) 2004-present Fabien Potencier

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
$

vendor/bin/php-vendor-credits .を実行することで、依存ライブラリのライセンスを含む情報が標準出力に出力されます。それを、CREDITSファイルにリダイレクトして保存しています。head -35 CREDITSでは、保存したファイルの先頭35行を表示して内容を確認しています。

まとめ

依存ライブラリのLICENSE同梱のためのgocreditsというツールを、PHP composer版を作ってみました。昨日から作りはじめた未熟なツールですが、エラー報告とか機能追加案等ありましたら、@smeghead か、GitHubのIssuesに登録していただけると嬉しいです。

コメントする

メールアドレスが公開されることはありません。 が付いている欄は必須項目です


The reCAPTCHA verification period has expired. Please reload the page.

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください