phpcheckstyle / phpcheckstyle
PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions
Installs: 160 420
Dependents: 14
Suggesters: 0
Security: 0
Stars: 164
Watchers: 15
Forks: 31
Open Issues: 18
Requires
- php: >=5.0.0
Requires (Dev)
- phpunit/phpunit: ^4.8
This package is auto-updated.
Last update: 2024-09-09 12:22:29 UTC
README
Overview
PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions. The tools checks the input PHP source code and reports any deviations from the coding convention.
The tool uses the PEAR Coding Standards as the default coding convention. But it allows you to configure it to suit your coding standards.
Please visit https://github.com/PHPCheckstyle/phpcheckstyle/wiki for more information and documentation
Requirements
- PHP 5.0 or newer.
- Web browser to view the checkstyle report (only for html view)
- That's all.
Installation
Installation with Composer
composer require phpcheckstyle/phpcheckstyle
or Add phpcheckstyle/phpcheckstyle
as a requirement to composer.json
:
{ "require": { "phpcheckstyle/phpcheckstyle": "dev-master" } }
Update your packages with composer update
or if installing from fresh, with composer install
.
Manual Installation
Just download https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip and unzip the distribution.
$> unzip PhpCheckstyle.zip
This will create a directory called phpcheckstyle
and expand all
files in it.
Testing with Vagrant
-
install VirtualBox
-
install Vagrant
-
launch
vagrant up
in the project root directory to start the VM -
In case of problem with the "guest additions", launch :
vagrant plugin install vagrant-vbguest
- to run PHPCheckstyle on itself, type
vagrant provision --provision-with run_phpcheckstyle
- to run PHPUnit, type
vagrant provision --provision-with run_phpunit
- to log inside the VM, type
vagrant ssh
Usage
-
Change directory to the PHPCheckstyle installation directory.
$> cd phpcheckstyle
-
Execute the
run.php
script providing the--src
option.$> php run.php --src <php source directory/file>
-
Use the
--help
option to see more options$> php run.php --help
License
See LICENSE