README

👁 Latest Stable Version
👁 GitHub stars
👁 Total Downloads
👁 GitHub Workflow Status
👁 Scrutinizer code quality
👁 Code Coverage
👁 License
👁 Donate!

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 with name.
• 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.