A24Studio Code Sniffer Coding Standards

Codesniffer is a tool used to detect coding standard violations in Php Projects.

This project contains the coding standard rule to be used in PHP Code sniffer for any project owned by A24Studio.

The standards are derived of PSR 0, 1 and 2 standards with additional checks on php docblock comments.

Dependencies

This coding standard is dependend on the PSR coding standards, the Generic standards, Zend coding standards and PEAR coding standards. All these, except the PSR coding standards, are installed by default.

The PSR Coding standards can be found here. To install the PSR coding standards, I recommend following the commands below:

 cd /usr/share/php/PHP/CodeSniffer/Standards
 sudo git clone https://github.com/klaussilveira/phpcs-psr PSR

If you are not able to get the files from the above repo, then you will need to get them from our chef server.

Browse to chef.dev.net and download the file PSR.tar.gz. Extract it inside the directory /usr/share/php/PHP/CodeSniffer/Standards

This will install the PSR coding standards on the system, but will not set them as the default.

Installation

• You will need to fork this repo
• Clone your fork and add the required upstream
• By Symlinking the project to the directory /usr/share/php/PHP/CodeSniffer/Standards
• You can now modify the sniffs and create a PR (read copyright info) and changes are immediately available in your sniffs
• Fetch the lastest changes from upstream and have them immediately available in your sniffs

OR

To install the coding standards, do the following:

cd /usr/share/php/PHP/CodeSniffer/Standards
sudo git clone [email protected]:A24Group/A24StudioCS.git

You must then

• Set the A24Studio coding standards as the defaults, execute the following code:

sudo phpcs --config-set default_standard A24StudioCS

You will probably get an error of a file that does not exist. Create the directory and file and try again.

• You will also need to update your pre-commit hooks to use the new standards that have been created. Edit the config file (.git/hooks/config), not pre-commit file (.git/hooks/pre-commit), in your git hooks, update the required line to:

PHPCS_CODING_STANDARD=A24StudioCS

A24StudioCS is the default standard that will be used. To use a custom ruleset the PHPCS_CODING_STANDARD needs to point to the custom ruleset of your project(The path is related to the root of the project). The custom ruleset should then in turn point to the respective standard you want to use.

Example of ruleset:

<?xml version="1.0"?>
<ruleset name="Triage">

<!--
    The name attribute of the ruleset tag is displayed
    when running PHP_CodeSniffer with the -v command line
    argument.
-->
<description>Triage Coding standards</description>

<!-- Patterns that needs to be ignored when running phpcs on the project. -->
<exclude-pattern>*.xml</exclude-pattern>

<!-- Include our custom standards -->
<rule ref="A24StudioCS"/>

</ruleset>

Example of the config located in .git/hooks/config

# path to phpcs "binary"
PHPCS_BIN=/usr/bin/phpcs

# the coding standard, you can also specify a path to your own standard here 
# e. g. /path/to/my/standard/dir/
PHPCS_CODING_STANDARD=phpcs-ruleset.xml

# comma-separated list of file patterns being ignored
PHPCS_IGNORE=

# egrep compatible pattern of  files to be checked
PHPCS_FILE_PATTERN="\.(php)$"

# ignore warnings
PHPCS_IGNORE_WARNINGS=1

# encoding
PHPCS_ENCODING=utf-8

Code sniffer as a git pre-commit hook

Installation

See instructions at https://github.com/s0enke/git-hooks/tree/master/phpcs-pre-commit. Please note that you will have to ensure that the pre-commit script is executable (chmod +x normally does the trick)

You will need to add this script to each project you wish to have tested against the standards.

You will also need to make the following change to the config file to tell the pre-commit hook to use the PSR standards installed on the pc.

A24StudioCS will be the default standard (To use a custom standard please read).

PHPCS_CODING_STANDARD=A24StudioCS

Usage

Now when ever you attempt to commit, the files you changed will be evaluated agains codesniffer. If any CS violations are found, the commit will terminate and these violations will be displayed to you. When using git-cola, these violations will display in the Command Output tab.