Coding Standards Fixer

Introduction

PHP-CS-Fixer is a great tool that detects and automatically corrects coding style issues in the code. Unlike tools like PHPStan or Psalm, PHP-CS-Fixer is not trying to find bugs in the code but rather ensures that the code follows a certain coding standard.

Installation

PHP-CS-Fixer can be installed as a development dependency using Composer:

composer require --dev friendsofphp/php-cs-fixer

Configuration

The configuration of PHP-CS-Fixer is done in the .cs.php file in the root directory of the project. This file contains all the rules that PHP-CS-Fixer should follow when fixing the code.

Configuration file

The list of all the available can be found in the documentation: List of Available Rules.

File: .cs.php

<?php

use PhpCsFixer\Config;

return (new Config())
    ->setUsingCache(false)
    ->setRiskyAllowed(true)
    ->setRules(
        [
            '@PSR1' => true,
            '@PSR2' => true,
            '@Symfony' => true,
            '@PSR12' => true,
            'strict_param' => true,
            'psr_autoloading' => true,
            'align_multiline_comment' => ['comment_type' => 'phpdocs_only'], // psr-5
            'phpdoc_to_comment' => false,
            'no_superfluous_phpdoc_tags' => false,
            'array_indentation' => true,
            'array_syntax' => ['syntax' => 'short'],
            'cast_spaces' => ['space' => 'none'],
            'concat_space' => ['spacing' => 'one'],
            'compact_nullable_type_declaration' => true,
            'nullable_type_declaration' => true,
            'nullable_type_declaration_for_default_null_value' => true,
            'declare_equal_normalize' => ['space' => 'single'],
            'declare_strict_types' => false,
            'increment_style' => ['style' => 'post'],
            'list_syntax' => ['syntax' => 'short'],
            'echo_tag_syntax' => ['format' => 'long'],
            'phpdoc_add_missing_param_annotation' => ['only_untyped' => false],
            'phpdoc_align' => false,
            'phpdoc_no_empty_return' => false,
            'phpdoc_order' => true, // psr-5
            'phpdoc_no_useless_inheritdoc' => false,
            'protected_to_private' => false,
            'yoda_style' => false,
            'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
            'ordered_imports' => [
                'sort_algorithm' => 'alpha',
                'imports_order' => ['class', 'const', 'function']
            ],
            'single_line_throw' => false,
            'fully_qualified_strict_types' => true,
            'global_namespace_import' => false,
        ]
    )
    ->setFinder(
        PhpCsFixer\Finder::create()
            ->in(__DIR__ . '/src')
            ->in(__DIR__ . '/tests')
            ->in(__DIR__ . '/config')
            ->in(__DIR__ . '/public')
            ->name('*.php')
            ->ignoreDotFiles(true)
            ->ignoreVCS(true)
    );

Composer command

To run the PHP-CS-Fixer with simplified commands, the following Composer scripts can be added to the composer.json file:

{
    "scripts": {
        "cs:check": "php-cs-fixer fix --dry-run --format=txt --verbose --diff --config=.cs.php --ansi",
        "cs:fix": "php-cs-fixer fix --config=.cs.php --ansi --verbose"
    }
}

Usage

To check the code for coding standard violations, run the following command:

composer cs:check

To automatically fix the coding standard violations, run the following command:

composer cs:fix