https://github.com/gentics/composer-plugin-license-check

https://github.com/gentics/composer-plugin-license-check

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/gentics/composer-plugin-license-check
• Owner: gentics
• License: mit
• Created: 2019-03-22T13:40:58.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-06T06:20:48.000Z (almost 4 years ago)
• Last Synced: 2024-09-25T21:49:15.401Z (3 months ago)
• Language: PHP
• Size: 15.6 KB
• Stars: 2
• Watchers: 15
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
metasyntactical / composer-plugin-license-check

===============================================

This composer plugin allows to define a white- and/or blacklist of licenses

packages which will be installed in a project will be validated against.

If a forbidden license is found in a package the installation of the particular

package will be failed.

Additionally a new composer command ``check-licenses`` is provided to list all

packages in the dependencies including their license and if it is allowed to

use.

## How to install

Installation procedure follows the general installation process of packages with

composer.

Run ``composer require metasyntactical/composer-plugin-license-check`` to add the

package to the ``composer.json`` and install the package.

## How to use

The composer plugin reacts on extra variables in the extra-section of the

composer.json.

```json

{

  "extra": {

    "metasyntactical/composer-plugin-license-check": {

      "whitelist": [],

      "blacklist": []

    }

  }

}

```

Just specify the allowed (whitelist) or forbidden (blacklist) licenses as array.

Use the license identifiers allowed/used in the version-property of the composer.json

to be compatible with the general usage.

**Important Note**: This plugin is licensed under MIT license. Even if you forbid

to use MIT licensed packages in your project the plugin itself is the only package

it would not complain about (otherwise further checking would not work obviously).