jmfontaine/projectlint

Check PHP project against a ruleset

ProjectLint - Enforce project layout rules

ProjectLint helps you declare and enforce project layout rules, ensuring your project stays consistent at all times., _(*1)

, _(*2)

This project is still in beta, there may be bugs and missing features., _(*3)

Requirements / Compatibility

ProjectLint requires PHP version 5.4.0 or greater. However using the latest version of PHP is highly recommended., _(*4)

It also supports the latest version of HHVM., _(*5)

Installation

See documentation for installation instructions., _(*6)

Usage

1. Create a projectlint.yml file in the root directory of your project. See documentation for detailled format information.
2. Run ProjectLint from your project directory:

$ php projectlint.phar

Note: The way to run ProjectLint depends on the way you installed it. Please see installation documentation for details., _(*7)

Documentation

The documentation for ProjectLint is available in the doc directory., _(*8)

Issues

Bug reports and feature requests can be submitted on the Github Issue Tracker., _(*9)

Contributing

See CONTRIBUTING.md for information., _(*10)

Author

Jean-Marc Fontaine, _(*11)

• Email: jm@jmfontaine.net
• Twitter: @jmfontaine
• Blog: jmfontaine.net

See also the list of contributors who participated in this project., _(*12)

License

ProjectLint is licensed under the BSD 3-Clause License. See the LICENSE file for details., _(*13)