dominikb / composer-license-checker
用于检查依赖项许可证并允许/阻止它们的实用工具。
2.6.0
2024-07-06 14:35 UTC
Requires
- php: ^7.3 || ^8.0
- ext-json: *
- composer/composer: ~2.2.23 || ^2.7.0
- guzzlehttp/guzzle: ^6.5.8 || ^7.4.5
- psr/simple-cache: ^1.0 || ^2.0 || ^3.0
- symfony/cache: ~4.2.12 || ^4.3.8 || ^5.2 || ^6.0 || ^7.0
- symfony/console: ^5.3 || ^6.0 || ^7.0
- symfony/css-selector: ^4.2 || ^5.2 || ^6.0 || ^7.0
- symfony/dom-crawler: ^5.2 || ^6.0 || ^7.0
Requires (Dev)
- mockery/mockery: ^1.3.3
- phpunit/phpunit: ^9.3
- symfony/var-dumper: ^4.2 || ^5.2 || ^6.0 || ^7.0
README
快速扫描依赖项,查看它们使用的许可证或检查CI中没有合并不想要的许可证。
每个许可证的摘要查找都在https://tldrlegal.com/上完成。
请详细了解您使用的许可证和未使用的许可证,不要将提供的摘要作为您的唯一信息。
安装
您可以通过composer安装此包
composer require --dev dominikb/composer-license-checker
使用方法
提供了两个独立的命令
./composer-license-checker check
./composer-license-checker report
使用 ./composer-license-checker help
获取通用使用信息,或使用语法 ./composer-license-checker help COMMAND_NAME
查看特定命令的更多信息。
./vendor/bin/composer-license-checker check \ --allowlist MIT \ # Fail if anything but MIT license is used --blocklist GPL \ # Fail if any dependency uses GPL --allow dominikb/composer-license-checker # Always allow this dependency regardless of its license vendor/bin/composer-license-checker report -p /path/to/your/project -c /path/to/composer.phar
Composer路径
默认情况下,此工具假定"composer"位于您的路径中,并且是一个有效的命令,可以调用Composer。
如果不是这种情况,请使用带有Composer位置的-c
或--composer
选项,而不是默认路径。此工具附带作为依赖项安装的Composer,因此您可以从--composer ./vendor/bin/composer
开始,前提是您在执行许可证检查时位于此工具的根目录中。
如果此工具找不到Composer,它将以状态码2退出,请参见下文。
退出代码
任何命令都返回以下退出代码之一
- 0: 正常
- 1: 在检查中发现违规许可证,或在创建报告时发生问题
- 2: 执行命令时发生内部错误,可能表示在内部调用Composer时存在问题
测试
composer test
代码覆盖率报告输出到build
文件夹。有关更多测试配置,请参阅.phpunit.xml.dist
。
变更日志
有关最近更改的更多信息,请参阅CHANGELOG。
贡献
有关详细信息,请参阅CONTRIBUTING。
安全
如果您发现任何与安全相关的问题,请通过电子邮件[email protected]而不是使用问题跟踪器。
鸣谢
许可证
MIT许可证(MIT)。有关更多信息,请参阅许可证文件。