Legal Licenses は、プロジェクトの依存関係に関するすべての重要な情報を含む 1 つのテキスト ファイルを生成するのに役立つユーティリティです。一部の組織では、オープン ソース ソフトウェア (OSS) の使用が厳しく管理および監査されており、すべての OSS ライブラリを簡単に文書化することが求められています。
このユーティリティは、プロジェクトのルートに、すべてのlicenses.md
関係のリスト、現在インストールされているバージョン、コミット SHA、その説明、ホームページ、ライセンスのリスト、および完全なライセンス テキスト (ファイルに存在する場合) を含む License.md ファイルを生成します。依存関係のソースコードを直接。この情報はcomposer.lock
ファイルから受け取るため、このユーティリティを使用するには、 composer update
またはcomposer install
少なくとも1回実行する必要があります。
職場でこのようなユーティリティが必要な場合は、複数のプロジェクトで必要になる可能性があります。したがって、このユーティリティをインストールする最も簡単で推奨される方法は、グローバル Composer パッケージとしてインストールすることです。
composer global require comcast/php-legal-licenses
Composer を介して php-legal-licenses をグローバルにインストールした場合は、どのプロジェクトでもスクリプトを実行できるはずです。 composer.lock
ファイルを作成するには、 composer update
またはcomposer install
少なくとも 1 回実行する必要があることに注意してください。
$ cd /path/to/my/project
$ which php-legal-licenses
> ~/.composer/vendor/bin/php-legal-licenses
$ php-legal-licenses generate
> Generating Licenses file...
> Done!
--hide-version
オプションを使用して依存関係のバージョンを非表示にすることもできます。
$ php-legal-licenses generate --hide-version
--csv
オプションを使用して CSV ファイルを出力できます。
$ php-legal-licenses generate --csv
または、両方のオプションを使用します。
$ php-legal-licenses generate --hide-version --csv
このユーティリティ自体に対して生成されるライセンス ファイルのスニペットを次に示します。
# Project Licenses
This file was generated by the Legal Licenses utility. It contains the name, version and commit sha, description, homepage, and license information for every dependency in this project.
## Dependencies
### psr/log (Version 1.0.2 | 4ebe3a8)
Common interface for logging libraries
Homepage: https://github.com/php-fig/log
Licenses Used: MIT
Copyright (c) 2012 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 (Version v3.3.6 | b087823)
Symfony Console Component
Homepage: https://symfony.com
Licenses Used: MIT
...