best-it/license-check

Tool to check licenses of used packages.

Maintainers

👁 best-it

Package info

github.com/bestit/license-check

Type:project

pkg:composer/best-it/license-check

Statistics

Installs: 170

Dependents: 2

Suggesters: 0

Stars: 2

Open Issues: 2

0.2.0 2021-04-19 07:40 UTC

Requires

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT c02190dfdb6c7a32b6b55eb201ef49a3bc167e68

  • best it AG <info.woop@bestit.de>

README

👁 Build Status
👁 Build Status
👁 Scrutinizer Code Quality
👁 Code Coverage

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.