arokettu/composer-license-manager

License management plugin for Composer

1.2.0 2023-11-29 00:31 UTC

This package is auto-updated.

Last update: 2024-04-29 01:34:22 UTC


README

Packagist Packagist Gitlab pipeline status

License management plugin for Composer.

Installation

composer require 'arokettu/composer-license-manager'

Features

The plugin is configured in the extras section of the composer.json file.

{
    "extras": {
        "arokettu/composer-license-manager": {
            "licenses": {
                "allowed": ["MIT", "LGPL-*"],
                "forbidden": ["GPL-3.0", "AGPL-*"],
                "allow-empty": true
            },
            "packages": {
                "allowed": ["foo/bar", "safenamespace/*"]
            },
            "enforced": true
        }
    }
}

Scan for undesired licenses

Run composer licenses:scan to check installed packages for undesired licenses.

Policy enforcement

With "enforced": true (default setting) the plugin will prevent installation of packages with undesired licenses during composer install and composer update.

Documentation

Read full documentation here: https://sandfox.dev/php/composer-license-manager.html

Also on Read the Docs: https://composer-license-manager.readthedocs.io/

Support

Please file issues on our main repo at GitLab: https://gitlab.com/sandfox/composer-license-manager/-/issues

Feel free to ask any questions in our room on Gitter: https://gitter.im/arokettu/community

License

The library is available as open source under the terms of the MIT License.