agentsib/symfony2-coding-standard

Symfony2 PHP CodeSniffer Coding Standard

Symfony2 PHP CodeSniffer Coding Standard

A code standard to check against the Symfony coding standards, _(*1)

Installation

1. Install phpcs:, _(*2)

   pear install PHP_CodeSniffer

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

   pear config-show | grep php_dir

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

   cd /path/to/pear/PHP/CodeSniffer/Standards
   git clone git://github.com/opensky/Symfony2-coding-standard.git Symfony2

4. Set Symfony2 as your default coding standard:, _(*5)

   phpcs --config-set default_standard Symfony2

5. ..., _(*6)

6. Profit!, _(*7)

   cd /path/to/my/project
   phpcs
   phpcs path/to/my/file.php

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

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

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

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

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