php legal licenses

php legal licenses

Licenças Legais é um utilitário que ajuda a gerar um único arquivo de texto contendo todas as informações importantes sobre as dependências de um projeto. Em algumas organizações, o uso de software de código aberto (OSS) é estritamente controlado e auditado e exige que cada biblioteca de OSS seja simplesmente documentada.

Este utilitário irá gerar um arquivo licenses.md na raiz do seu projeto que contém uma lista de todas as dependências, a versão atualmente instalada, commit sha, sua descrição, página inicial, lista de licenças e texto completo da licença, se estiver presente no código-fonte da dependência diretamente. Ele recebe essas informações do arquivo composer.lock , portanto, você deve ter executado uma composer update ou composer install compositor pelo menos uma vez para usar este utilitário.

Instalação

Se você precisar de um utilitário como este para o seu local de trabalho, é provável que precise dele para mais de um projeto. Portanto, a maneira mais fácil e recomendada de instalar este utilitário é como um pacote global do compositor:

composer global require comcast/php-legal-licenses

Uso

Se você instalou php-legal-licenses globalmente via compositor, você poderá executar o script em qualquer um dos seus projetos. Observe que você deve ter executado composer update ou composer install pelo menos uma vez para criar um arquivo composer.lock .

 $ cd /path/to/my/project
$ which php-legal-licenses
> ~/.composer/vendor/bin/php-legal-licenses
$ php-legal-licenses generate
> Generating Licenses file...
> Done!

Você também pode ocultar a versão da dependência com a opção --hide-version :

 $ php-legal-licenses generate --hide-version

Você pode gerar o arquivo csv com a opção --csv :

 $ php-legal-licenses generate --csv

Ou use as duas opções:

 $ php-legal-licenses generate --hide-version --csv

Exemplo de saída

Aqui está um trecho do arquivo de licenças que seria gerado para este utilitário:

 # 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

...