php legal licenses

php legal licenses

Юридические лицензии — это утилита, помогающая создать единый текстовый файл, содержащий всю важную информацию о зависимостях проекта. В некоторых организациях использование программного обеспечения с открытым исходным кодом (OSS) строго контролируется и проверяется и требует простого документирования каждой библиотеки OSS.

Эта утилита создаст файл licenses.md в корне вашего проекта, который будет содержать список всех зависимостей, текущую установленную версию, sha фиксации, ее описание, домашнюю страницу, список лицензий и полный текст лицензии, если он присутствует в файле. исходный код зависимости напрямую. Он получает эту информацию из файла composer.lock , поэтому вам необходимо хотя бы один раз запустить composer update или composer install , чтобы использовать эту утилиту.

Установка

Если вам нужна такая утилита для вашего предприятия, скорее всего, она понадобится вам более чем для одного проекта. Поэтому самый простой и рекомендуемый способ установить эту утилиту — использовать глобальный пакет композитора:

composer global require comcast/php-legal-licenses

Использование

Если вы установили php-legal-licenses глобально через композитор, вы сможете запустить скрипт в любом из ваших проектов. Обратите внимание: для создания файла composer.lock вам необходимо хотя бы один раз запустить composer update или composer install .

 $ 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

...