This tool can be used to check the licenses of the used packages.
Our package can be installed with composer with the following command:
composer require best-it/license-check --dev --prefer-dist
Create one or more YAML configuration files (license-check.yml) like this:
allowed-licenses:
- MIT
allowed-packages:
composer:
- /best-it\/license-check/
- /best-it\/.*/
node:
- /test\/test/
The allowed packages must be defined as a regular expression.
If multiple files are passed as an argument they will be merged to a single configuration.
Execute the following command to get a report which includes the information that everything is compatible or that some dependencies are not compatible with your configuration. In case of problems the error code is 1.
./vendor/bin/license-check
See CONTRIBUTING.md.