Download the PHP package php-composter/php-composter-regular-expression without Composer
On this page you can find all versions of the php package php-composter/php-composter-regular-expression. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download php-composter/php-composter-regular-expression
More information about php-composter/php-composter-regular-expression
Files in php-composter/php-composter-regular-expression
Package php-composter-regular-expression
Short Description PHP Composter regular expression checks.
License MIT
Informations about the package php-composter-regular-expression
PHP Composter Regular Expressions
PHP Composter regular expression checks.
This Composer package will check your commit messages to make sure they match a set of regular expression rules.
This is a PHP Composter Action.
Table Of Contents
- Installation
- Basic Usage
- Contributing
Installation
First, you need to add the package as a development requirement to your composer.json
:
Then, you need to add the regular expressions you want to check for. As an example, the following expression will ensure that commit message subject lines start with one of the following words: feature
, bug
, documentation
, style
:
Basic Usage
It should just work when you git commit
.
Composer Extra Reference
The Composer extra entry takes the following format:
Each hook can contain multiple content elements to check, and each content element can contain multiple rules.
The regular expression will be wrapped in special delimiter chars (chr(1)
), so you don't need to include these.
Supported hooks
commit-message
:
Check the commit message after it has been submitted.
Supported content elements
For the commit-message
hook
subject
:
Subject line of the commit message, meaning the very first line of the commit message up until the first EOL character.
body
:
Body of the commit message, meaning everything after the first EOL character.
Supported rules
has
:
Passes the check if the regular expression results in one or more matches.
has-not
:
Passes the check if the regular expression results in no matches.
Contributing
All feedback / bug reports / pull requests are welcome.