MO4 CodeSniffer ruleset

Provides a CodeSniffer ruleset

MO4 standard

Requires

##MO4 Coding Standard

The MO4 Coding Standard is an extension of the Symfony Coding Standard and adds following rules:

short tags "[...]" must be used instead of "array(...)",
in associates arrays, the "=>" operators must be aligned,
in arrays, the key and '=>' operator must be on the same line.
each consecutive variable assignements must align on the assigment operator,
use statements must be sorted,
you should use the imported class name, whenever it was imported with a use statement,
variables in double quoted strings must be surrounded by { }, e.g. "{$VAR}" instead of "$VAR",
sprintf or "{$VAR1} {$VAR2}" must be used instead of the concat operator, concat opetor are only allowed to concat constant an multi line strings,
a white space is requried after each cast opetor, e.g. "(int) $value" instead of "(int)$value",

Installation

Install phpcs:
```
 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 Symfony inside the phpcs Standards directory:

 cd /path/to/pear/PHP/CodeSniffer/Standards
 git clone git://github.com/xalopp/symfony-coding-standard.git Symfony
 git clone git://github.com/Mayflower/mo4-coding-standard.git MO4

Select the Symfony ruleset as your default coding standard:
```
 phpcs --config-set default_standard MO4
```
Profit
```
 phpcs path/to/my/file.php
```

Contributing

If you contribute code to these sniffs, please make sure it conforms to the PEAR coding standard and that the unit tests still pass.

To check the coding standard, run from the Symfony-coding-standard source root:

    phpcs --ignore=Tests --standard=PEAR . -n

The unit-tests are run from within the PHP_CodeSniffer directory

get the CodeSniffer repository
get the Symfony Coding Standard and symlink, copy or clone it at CodeSniffer/Standards/Symfony
symlink, copy or clone this repository at CodeSniffer/Standards/MO4
from the CodeSniffer repository root run phpunit --filter Symfony_ tests/AllTests.php

Credit

Licence

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

elseym/mo4-coding-standard

MO4 CodeSniffer ruleset

Installation

Contributing

Credit

Licence