leaphub/phpcs-symfony2-standard

A PHP_CodeSniffer standard for Symfony 2 applications

Symfony2 PHP_CodeSniffer Coding Standard

A composer installable coding standard to check against the Symfony coding standards., _(*1)

This project was based on the standard provided by @lapistano, _(*2)

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:, _(*3)

Using Composer

1. Install The standard as dependency of your composer based project (It will install the composer version of PHP_CodeSniffer as dependency):, _(*4)

   $ php composer.phar require --dev leaphub/phpcs-symfony2-standard:~2.0.0

2. Profit!, _(*5)

   $ bin/phpcs --standard=vendor/leaphub/phpcs-symfony2-standard/leaphub/phpcs/Symfony2/ --extensions=php src/

Using PEAR

1. Install PHP_CodeSniffer:, _(*6)

   $ pear install PHP_CodeSniffer

2. Find your PEAR directory:, _(*7)

   $ pear config-show | grep php_dir

3. Copy, symlink or check out this repo to a folder called Symfony2 inside the phpcs Standards directory:, _(*8)

   $ cd /path/to/pear/PHP/CodeSniffer/Standards
   $ git clone git@github.com:leaphub/phpcs-symfony2-standard.git Symfony2

4. Set Symfony2 as your default coding standard if cou want:, _(*9)

   $ phpcs --config-set default_standard Symfony2

5. Profit!, _(*10)

   $ 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., _(*11)

To check the coding standard, run from the Symfony2-coding-standard source root:, _(*12)

$ phpcs --ignore=*/tests/* --standard=PEAR . -n

The unit-tests are run from within the PHP_CodeSniffer directory:, _(*13)

$ phpunit --filter Symfony2_* tests/AllTests.php