PHPackages phpcheckstyle/phpcheckstyle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. phpcheckstyle/phpcheckstyle ActiveLibrary[Utility & Helpers](/categories/utility) phpcheckstyle/phpcheckstyle =========================== PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions V0.14.8(7y ago)166184.4k↓25%32[18 issues](https://github.com/PHPCheckstyle/phpcheckstyle/issues)11OSL-2.1PHPPHP >=5.0.0 Since Mar 31Pushed 3y ago14 watchersCompare [ Source](https://github.com/PHPCheckstyle/phpcheckstyle)[ Packagist](https://packagist.org/packages/phpcheckstyle/phpcheckstyle)[ Docs](https://github.com/phpcheckstyle/phpcheckstyle/)[ RSS](/packages/phpcheckstyle-phpcheckstyle/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (1)Versions (11)Used By (11) PHPCheckstyle ============= [](#phpcheckstyle) [![Build Status](https://camo.githubusercontent.com/745ad65f35379ab1ffd4e90ee4b0ec4a7e2621bc58596f99a8ea787f34f5a784/68747470733a2f2f7472617669732d63692e6f72672f504850436865636b7374796c652f706870636865636b7374796c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/PHPCheckstyle/phpcheckstyle) Overview -------- [](#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 for more information and documentation Requirements ------------ [](#requirements) - PHP 5.0 or newer. - Web browser to view the checkstyle report (only for html view) - That's all. Installation ------------ [](#installation) ### Installation with Composer [](#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 [](#manual-installation) Just download and unzip the distribution. ``` $> unzip PhpCheckstyle.zip ``` This will create a directory called `phpcheckstyle` and expand all files in it. ### Testing with Vagrant [](#testing-with-vagrant) - install [VirtualBox](https://www.virtualbox.org/) - install [Vagrant](https://www.vagrantup.com/) - 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 ----- [](#usage) - Change directory to the PHPCheckstyle installation directory. ``` $> cd phpcheckstyle ``` - Execute the `run.php` script providing the `--src` option. ``` $> php run.php --src ``` - Use the `--help` option to see more options ``` $> php run.php --help ``` License ======= [](#license) See [LICENSE](/LICENSE.txt) ### Health Score 44 — FairBetter than 92% of packages Maintenance18 Infrequent updates — may be unmaintained Popularity50 Moderate usage in the ecosystem Community33 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 56% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~265 days Recently: every ~145 days Total 7 Last Release 2839d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/e8ac25a88d001c7358536a36211db67bf09a222d9a7d2fb1767c257e92940e2f?d=identicon)[Tchule](/maintainers/Tchule) --- Top Contributors [![tchule](https://avatars.githubusercontent.com/u/5270224?v=4)](https://github.com/tchule "tchule (201 commits)")[![jbrooksuk](https://avatars.githubusercontent.com/u/246103?v=4)](https://github.com/jbrooksuk "jbrooksuk (76 commits)")[![IGNBPesty](https://avatars.githubusercontent.com/u/36155135?v=4)](https://github.com/IGNBPesty "IGNBPesty (73 commits)")[![hafah](https://avatars.githubusercontent.com/u/5660193?v=4)](https://github.com/hafah "hafah (2 commits)")[![GuillermoMI](https://avatars.githubusercontent.com/u/6951800?v=4)](https://github.com/GuillermoMI "GuillermoMI (2 commits)")[![alevoska](https://avatars.githubusercontent.com/u/512417?v=4)](https://github.com/alevoska "alevoska (1 commits)")[![popojargo](https://avatars.githubusercontent.com/u/9197078?v=4)](https://github.com/popojargo "popojargo (1 commits)")[![rightshift-juantaylor](https://avatars.githubusercontent.com/u/6469159?v=4)](https://github.com/rightshift-juantaylor "rightshift-juantaylor (1 commits)")[![royopa](https://avatars.githubusercontent.com/u/442991?v=4)](https://github.com/royopa "royopa (1 commits)")[![hueypark](https://avatars.githubusercontent.com/u/7126328?v=4)](https://github.com/hueypark "hueypark (1 commits)") --- Tags checkstylecoding-conventionsphpphpcheckstylestandardconventioncheckstyle ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/phpcheckstyle-phpcheckstyle/health.svg) ``` [![Health](https://phpackages.com/badges/phpcheckstyle-phpcheckstyle/health.svg)](https://phpackages.com/packages/phpcheckstyle-phpcheckstyle) ``` ### Alternatives [kigkonsult/icalcreator iCalcreator is the PHP implementation of rfc2445/rfc5545 and rfc updates, management of calendar information 2462.6M16](/packages/kigkonsult-icalcreator)[marcocesarato/php-conventional-changelog Generate changelogs and release notes from a project's commit messages and metadata and automate versioning with semver.org and conventionalcommits.org 2511.3M109](/packages/marcocesarato-php-conventional-changelog)[mnapoli/pretty Run all code formatting tools with one command: pretty 1085.1k9](/packages/mnapoli-pretty)[bernardosilva/git-hooks-php Composer git-hook package with hooks for your php projects. 2516.7k1](/packages/bernardosilva-git-hooks-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)