php legal licenses

php legal licenses

Licencias legales es una utilidad para ayudar a generar un único archivo de texto que contiene toda la información importante sobre las dependencias de un proyecto. En algunas organizaciones, el uso de software de código abierto (OSS) está estrictamente controlado y auditado, y requiere que cada biblioteca de OSS esté documentada de forma sencilla.

Esta utilidad generará un archivo licenses.md en la raíz de su proyecto que contiene una lista de todas las dependencias, la versión instalada actualmente, el sha de confirmación, su descripción, página de inicio, lista de licencias y el texto completo de la licencia si está presente en el código fuente de dependencia directamente. Recibe esta información del archivo composer.lock , por lo que debe haber ejecutado una composer update o composer install al menos una vez para poder utilizar esta utilidad.

Instalación

Si necesita una utilidad como esta para su lugar de trabajo, es probable que la necesite para más de un proyecto. Por lo tanto, la forma más sencilla y recomendada de instalar esta utilidad es como un paquete de composición global:

composer global require comcast/php-legal-licenses

Uso

Si instaló php-legal-licenses globalmente a través de Composer, debería poder ejecutar el script en cualquiera de sus proyectos. Tenga en cuenta que debe haber ejecutado composer update o composer install al menos una vez para crear un archivo 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!

También puedes ocultar la versión de dependencia con la opción --hide-version :

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

Puede generar un archivo csv con la opción --csv :

 $ php-legal-licenses generate --csv

O use ambas opciones:

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

Salida de ejemplo

Aquí hay un fragmento del archivo de licencias que se generaría para esta utilidad:

 # 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

...