Legal Licenses ist ein Dienstprogramm, das dabei hilft, eine einzelne Textdatei zu erstellen, die alle wichtigen Informationen über die Abhängigkeiten eines Projekts enthält. In einigen Organisationen wird die Verwendung von Open-Source-Software (OSS) streng kontrolliert und geprüft und erfordert eine einfache Dokumentation jeder OSS-Bibliothek.
Dieses Dienstprogramm generiert eine Datei licenses.md
im Stammverzeichnis Ihres Projekts, die eine Liste aller Abhängigkeiten, die aktuell installierte Version, das Commit-Sha, seine Beschreibung, die Homepage, eine Liste der Lizenzen und den vollständigen Lizenztext enthält, sofern dieser im Projekt vorhanden ist Abhängigkeitsquellcode direkt. Es erhält diese Informationen aus der Datei composer.lock
, daher müssen Sie mindestens einmal ein composer update
oder composer install
ausgeführt haben, um dieses Dienstprogramm verwenden zu können.
Wenn Sie ein solches Dienstprogramm für Ihren Geschäftssitz benötigen, ist die Wahrscheinlichkeit groß, dass Sie es für mehr als ein einzelnes Projekt benötigen. Daher ist die einfachste und empfohlene Möglichkeit, dieses Dienstprogramm zu installieren, die Verwendung eines globalen Composer-Pakets:
composer global require comcast/php-legal-licenses
Wenn Sie php-legal-licenses global über Composer installiert haben, sollten Sie das Skript in jedem Ihrer Projekte ausführen können. Beachten Sie, dass Sie entweder composer update
oder composer install
mindestens einmal ausgeführt haben müssen, um eine composer.lock
Datei zu erstellen.
$ cd /path/to/my/project
$ which php-legal-licenses
> ~/.composer/vendor/bin/php-legal-licenses
$ php-legal-licenses generate
> Generating Licenses file...
> Done!
Sie können die Abhängigkeitsversion auch mit der Option --hide-version
ausblenden:
$ php-legal-licenses generate --hide-version
Sie können eine CSV-Datei mit der Option --csv
ausgeben:
$ php-legal-licenses generate --csv
Oder nutzen Sie beide Optionen:
$ php-legal-licenses generate --hide-version --csv
Hier ist ein Ausschnitt der Lizenzdatei, die für dieses Dienstprogramm selbst generiert würde:
# 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
...