|
|
The rules are based on the "Generic" ruleset included by PHP Code
Sniffer, with a significant portion of the rules disabled. This is a
tradeoff between getting some useful feedback, and not being overloaded
by noise.
I've tried to encode a coe style that resembles the existing code as
much as possible, but have included some sniffs that requires code
changes to satisfy the style. This is meant as a starting point, and we
can disable or enable more sniffs as we see fit.
PHPCS also has ready rule sets for other common coding standards we may
want to gravitate towards, e.g. PSR-12. Others are available from the
community.
The best way to run PHPCS is to integrate it with your editor, so that
it will display diacnostics inline when saving or modifying the code. It
can also be run from the command line like this:
./vendor/bin/phpcs -n [<path-to-file-to-check>]
If no file is specified it will try to check the entire project.
The `-n` means don't bother with warnings (I recommend that to begin
with. Enable the warnings when the errors are taken care of.)
|
