A.2. Coding Standards Analysis

In order to improve the consistency and readability of the source code, we run a coding style analysis tool everytime changes are pushed in the repo. For new contributions we are going to be enforcing coding standards to ensure that the coding style in the source code is consistent. Ensuring that your code meets these standards will make the process of code contribution smoother.

The Joomla Platform sniffer rules are written to be used with a tool called PHP_CodeSniffer. Please see the PHP_CodeSniffer Pear Page for information on installing PHP_CodeSniffer on your system.

A.2.1. Running CodeSniffer

You can run the CodeSniffer by going to the platform root directory and executing

phpcs --report=checkstyle --report-file=build/logs/checkstyle.xml --standard=/path/to/platform/build/phpcs/Joomla /path/to/platform

Alternatively, if you have Ant installed on your system, you may run the CodeSniffer by going to the platform root directory and executing ant phpcs