Download the PHP package purplebooth/git-lint-validators without Composer
On this page you can find all versions of the php package purplebooth/git-lint-validators. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package git-lint-validators
This package is abandoned and no longer maintained. The author suggests using the sebastianfeldmann/captainhook package instead.
Git Lint
This project is designed to ensure that the commits you're making to a repository follow the git coding style. This is simply the basic validators.
The standard that they test for is the one described by Chris Beams.
The validations it implements are:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters (soft limit, hard limit at 69)
- Capitalize the subject line
- Do not end the subject line with a period
- Wrap the body at 72 characters
Getting Started
Prerequisities
You'll need to install:
- PHP (Minimum 7.0)
Installing
Usage
Tool
You can try out this library by using it as a git commit hook.
Git hook installation
Use the install-git-hook
Composer script to install the hook. An existing hook is
backed to .git/hooks/commit-msg.bak
.
It's fairly customisable too, here are some options:
Output While Running
Git commit message template installation
Use the install-git-commit-message-template
Composer script to install and configure a commit message template following the rules of Chris Beams.
The commit message template is written to .git/.gitmessage
and will than be used when issuing a git commit
w/o the message option.
Library
You can use the whole library
Alternatively you could use the validators alone
Please depend on the interfaces rather than the concrete implementations. Concrete implementations may change without causing a BC break, interfaces changing will cause major version increment, indicating a BC break.
Running the tests
First checkout the library, then run
Coding Style
We follow PSR2, and also enforce PHPDocs on all functions. To run the tests for coding style violations
Unit tests
We use PHPSpec for unit tests. To run the unit tests
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
See the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details.