leaphub / phpcs-symfony2-standard
A PHP_CodeSniffer standard for Symfony 2 applications
Installs: 703 582
Dependents: 40
Suggesters: 1
Security: 0
Stars: 46
Watchers: 6
Forks: 133
Open Issues: 0
Requires
README
A composer installable coding standard to check against the Symfony coding standards.
This project was based on the standard provided by @lapistano
Installation
This coding standard can be installed via composer or be used in you PHP_CodeSniffer install over PECL. Both ways are described in the following but the composer way is recommedend:
Using Composer
-
Install The standard as dependency of your composer based project (It will install the composer version of PHP_CodeSniffer as dependency):
$ php composer.phar require --dev leaphub/phpcs-symfony2-standard:~2.0.0
-
Profit!
$ bin/phpcs --standard=vendor/leaphub/phpcs-symfony2-standard/leaphub/phpcs/Symfony2/ --extensions=php src/
Using PEAR
-
Install PHP_CodeSniffer:
$ pear install PHP_CodeSniffer
-
Find your PEAR directory:
$ pear config-show | grep php_dir
-
Copy, symlink or check out this repo to a folder called Symfony2 inside the phpcs
Standards
directory:$ cd /path/to/pear/PHP/CodeSniffer/Standards $ git clone git@github.com:leaphub/phpcs-symfony2-standard.git Symfony2
-
Set Symfony2 as your default coding standard if cou want:
$ phpcs --config-set default_standard Symfony2
-
Profit!
$ phpcs --standard=Symfony2 --extensions=php src/
Contributing
If you do contribute code to these sniffs, please make sure it conforms to the PEAR coding standard and that the Symfony2-coding-standard unit tests still pass.
To check the coding standard, run from the Symfony2-coding-standard source root:
$ phpcs --ignore=*/tests/* --standard=PEAR . -n
The unit-tests are run from within the PHP_CodeSniffer directory:
$ phpunit --filter Symfony2_* tests/AllTests.php