best-it / license-check
Tool to check licenses of used packages.
Installs: 145
Dependents: 2
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 2
Type:project
Requires
- php: ^8.0
- symfony/config: ^4.4 || ^5.2
- symfony/console: ^4.4 || ^5.2
- symfony/dependency-injection: ^4.4 || ^5.2
- symfony/finder: ^4.4 || ^5.2
- symfony/yaml: ^4.4 || ^5.2
Requires (Dev)
- best-it/php_codesniffer: dev-release/4.0.0
- phpmd/phpmd: ^2.9
- phpstan/phpstan: ^0.12.80
- phpunit/phpunit: ^9.5
- sebastian/phpcpd: ^6.0
This package is auto-updated.
Last update: 2024-11-17 16:03:55 UTC
README
This tool can be used to check the licenses of the used packages.
Installation
Our package can be installed with composer with the following command:
composer require best-it/license-check --dev --prefer-dist
Usage
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
Development / Contributing
See CONTRIBUTING.md.