loophp / grumphp-license-task
Provide a task for GrumPHP that check if the License file is valid.
Fund package maintenance!
drupol
Installs: 61 492
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 1
Requires
- php: >= 7.4
- composer/spdx-licenses: ^1.5.5
- ergebnis/license: ^1.1
Requires (Dev)
- ext-pcov: *
- drupol/phpcsfixer-configs-php: ^2
- ergebnis/composer-normalize: ^2.28
- friends-of-phpspec/phpspec-code-coverage: ^6.1
- infection/infection: ^0.26.0
- infection/phpspec-adapter: ^0.2
- php-parallel-lint/php-parallel-lint: ^1.3
- phpro/grumphp: ^1.3
- phpspec/phpspec: ^7.0
- phpstan/phpstan: ^1.0
- vimeo/psalm: ^4.27
README
GrumPHP License Task
Description
This package provides a new GrumPHP task: license
.
This task ensure that your project contains a valid license.
Features
Make sure the LICENSE
file exists in your project.
If it already exists, it make sure it is valid. If it is not valid, GrumPHP will propose to fix it for you.
If it doesn't exist, GrumPHP will create the file.
Installation
composer require loophp/grumphp-license-task --dev
Then, edit your GrumPHP configuration file and register the extension:
grumphp: extensions: - loophp\GrumphpLicenseTask\Extension
Usage
Use the new license
task provided by this extension:
taks: license: name: MIT date_from: 2021 holder: Pol Dellaiera
Available options
name
: (string) The OSI name of the license (see Available license).input
: (string) The filepath to the file to use as license. Cannot be used in conjuction withname
.output
: (string) The output filename to use to save the license in.date_from
: (int) The 'from' date in year.holder
: (string) The holder's name.
Available licenses
- BSD-3-Clause
- EUPL-1.2
- MIT
- LGPL-2.0
- LGPL-2.1
- LGPL-3.0
- (submit an issue/pr to add more)
Contributing
Report bug on the issue tracker.
See the file CONTRIBUTING.md but feel free to contribute to this library by sending Github pull requests.
Changelog
See CHANGELOG.md for a changelog based on git commits.
For more detailed changelogs, please check the release changelogs.