jmfontaine / projectlint
Check PHP project against a ruleset
Installs: 13
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=5.3.0
- psr/log: ~1.0
- symfony/config: ~2.5.0
- symfony/console: ~2.5.0
- symfony/expression-language: ~2.5.0
- symfony/filesystem: ~2.5.0
- symfony/finder: ~2.5.0
Requires (Dev)
- mikey179/vfsstream: ~1.3.0
- phpunit/phpunit: ~4.2.0
- squizlabs/php_codesniffer: ~1.5.4
This package is not auto-updated.
Last update: 2023-10-14 13:45:13 UTC
README
ProjectLint helps you declare and enforce project layout rules, ensuring your project stays consistent at all times.
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
- Create a
projectlint.yml
file in the root directory of your project. See documentation for detailled format information. - 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
- Email: jm@jmfontaine.net
- Twitter: @jmfontaine
- Blog: jmfontaine.net
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.