jmfontaine/projectlint

Check PHP project against a ruleset

0.1.0 2014-08-17 20:40 UTC

README

ProjectLint helps you declare and enforce project layout rules, ensuring your project stays consistent at all times.

Build Status

This project is still in beta, there may be bugs and missing features.

Requirements / Compatibility

ProjectLint requires PHP version 5.4.0 or greater. However using the latest version of PHP is highly recommended.

It also supports the latest version of HHVM.

Installation

See documentation for installation instructions.

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.

Documentation

The documentation for ProjectLint is available in the doc directory.

Issues

Bug reports and feature requests can be submitted on the Github Issue Tracker.

Contributing

See CONTRIBUTING.md for information.

Author

Jean-Marc Fontaine

See also the list of contributors who participated in this project.

License

ProjectLint is licensed under the BSD 3-Clause License. See the LICENSE file for details.