README

A custom ruleset for PHP CodeSniffer and PHP-CS-Fixer for use in the Driver and Vehicles Standard Agency (DVSA). PHP Coding standards are maintained and updated by the developer community at the DVSA. See CONTRIBUTING.md for more information how make changes.

Prerequisites

Composer
at least PHP 7.4
Git

Installation

composer require --dev dvsa/coding-standards

or if you install the coding standard tools globally use:

composer require global dvsa/coding-standards

How to set up

Refer to the Integrations or How to run section for help with running/integrating in with code editors/IDE.

PHP CodeSniffer

Repository: https://github.com/squizlabs/PHP_CodeSniffer.

Create a phpcs.dist.xml file in the root directory of your project. Example:

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="DVSA" xsi:noNamespaceSchemaLocation="./vendor/squizlabs/php_codesniffer/phpcs.xsd">
  <file>./path/to/directory</file>
  <file>./path/to/file.php</file>

  <exclude-pattern>*/vendor/*</exclude-pattern>

  <rule ref="./vendor/dvsa/coding-standards/src/Profiles/DVSA/CS/ruleset.xml" />
</ruleset>

XML reference.

PHP-CS-Fixer

Repository: https://github.com/FriendsOfPHP/PHP-CS-Fixer.

Due to the number of dependencies in php-cs-fixer it must be installed manually.

Recommended way to install using composer-bin-plugin.

$ composer require --dev bamarni/composer-bin-plugin

Install php-cs-fixer. It is recommended to install PHP-CS-Fixer in a separate working directory:
```
$ composer bin php-cs-fixer require friendsofphp/php-cs-fixer dvsa/coding-standards
```
Create a .php-cs-fixer.dist.php file in the root directory of your project.
Add .php-cs-fixer.cache to your .gitignore. The cache filename can be changed using the $cacheFilename parameter (default: .php-cs-fixer.cache).

Configure and return a PhpCsFixer\ConfigInterface object. This repository provides a preconfigured class:

<?php
$cacheFilename = '.php-cs-fixer.cache';

$finder = PhpCsFixer\Finder::create()
    ->exclude('vendor')
    ->in(__DIR__);

// Any additional project rules/rule sets.
$additionalRules = [
    // Rule sets
    '@PHP80Migration:risky' => true,
    '@PHP81Migration' => true,
    '@Symfony' => true,
    '@Symfony:risky' => true,
    // Individual rules
    'protected_to_private' => false,
];

return (new \Dvsa\PhpCodingStandards\PhpCsFixer\Config())($finder, $additionalRules, $cacheFilename);

Tip: Add .php-cs-fixer.php to your .gitignore to enable additional rules locally.

How to run

GitHooks

Recommended using a tool to handle the GitHooks functionality due to the manual steps to set up hooks (symlinks/copying). Lots of tools can be used to handle GitHooks.

Husky & lint-staged (NPM)

Repositories: Husky & lint-staged package.

Install using NPM:

$ npm i --save-dev husky lint-staged

Configure Husky:

$ npm set-script prepare "husky install"
$ npm run prepare

Create .lintstagedrc:

{
   "**/*.php": [
      "php ./vendor/bin/php-cs-fixer fix --diff --quiet",
      "php ./vendor/bin/phpcs --standard=./phpcs.dist.xml --report=diff --colors"
   ]
}

Add lint-staged to the pre-commit hook:

$ npx husky add .husky/pre-commit "lint-staged"

The above pre-commit hook will utilise both PHP-CS-Fixer and PHPCS. The fixer will be run before PHP CodeSniffer.

Integrations

JetBrains (IntelliJ/PHPStorm)

JetBrains have comprehensive documentation for setting up code quality tools.

PHP CodeSniffer path to ruleset: /phpcs.dist.xml PHP CS Fixer path to ruleset: /.php-cs-fixer.dist.php

Licence

See LICENSE.md

Contributing

See CONTRIBUTING.md

Acknowledgements

This coding standard is a tweak on top of the PSR2 standard and only possible because of that. However particularly the time and effort of Chris Emerson BJSS is acknowledged for tidying this and working on it during his time on the VOL project.

dvsa / coding-standards

Maintainers

Details