README

PHP coding standard used in Alma Career Czechia (formerly LMC) products.

Standard is based on PSR-12 and adds various checks to make sure the code is readable, follows the same conventions, and does not contain common mistakes.

We use EasyCodingStandard to define and execute checks created for both PHP-CS-Fixer and PHP_CodeSniffer.

Installation

composer require --dev lmc/coding-standard

Usage

Create ecs.php file in the root directory of your project and import the code-style rules:

<?php declare(strict_types=1);

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests']) // optionally add 'config' or other directories with PHP files
    ->withRootFiles() // to include ecs.php and all other php files in the root directory
    ->withSets(
        [
            __DIR__ . '/vendor/lmc/coding-standard/ecs.php',
        ]
    );
    
    // By default, only checks compatible with PHP 8.0 are enabled.
    // Depending on the lowest PHP version your project needs to support, you can enable additional checks.

    // Import one of ecs-8.1.php, ecs-8.2.php or ecs-8.3.php. Use only one additional file (for the highest possible
    // PHP version), the configs for previous versions are automatically included.
    //->withSets(
    //    [
    //        __DIR__ . '/vendor/lmc/coding-standard/ecs.php',
    //        __DIR__ . '/vendor/lmc/coding-standard/ecs-8.3.php',
    //    ]
    //);

Run the check command

vendor/bin/ecs check

Optionally we recommend adding this to scripts section of your composer.json:

    "scripts": {
        "analyze": [
            "vendor/bin/ecs check --ansi",
            "[... other scripts, like PHPStan etc.]"
        ],
        "fix": [
            "...",
            "vendor/bin/ecs check --ansi --fix"
        ],
    }

Now you will be able to run the fix using composer analyze and execute automatic fixes with composer fix.

Add custom checks or override default settings

On top of default code-style rules you are free to add any rules from PHP-CS-Fixer or PHP_CodeSniffer. If needed, you can also override some default settings.

<?php declare(strict_types=1);

use PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff;
use PhpCsFixer\Fixer\PhpUnit\PhpUnitTestAnnotationFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    /* (...) */
    ->withSets(
        [
            __DIR__ . '/vendor/lmc/coding-standard/ecs.php',
        ]
    )
    // Enforce line-length to 120 characters
    ->withConfiguredRule(LineLengthSniff::class, ['absoluteLineLimit' => 120])
    // Tests must have @test annotation
    ->withConfiguredRule(PhpUnitTestAnnotationFixer::class, ['style' => 'annotation']);
    /* (...) */

See EasyCodingStandard docs for more configuration options.

Exclude (skip) checks or files

You can configure your ecs.php to entirely skip some files, disable specific checks or suppress specific errors.

<?php declare(strict_types=1);

use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff;
use PHP_CodeSniffer\Standards\Squiz\Sniffs\Arrays\ArrayDeclarationSniff;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    /* (...) */
    ->withSkip(
        [
            // Ignore specific check only in specific files
            ForbiddenFunctionsSniff::class => [__DIR__ . '/src-tests/bootstrap.php'],
            // Disable check entirely
            ArrayDeclarationSniff::class,
            // Skip one file
            __DIR__ . '/file/to/be/skipped.php',
            // Skip entire directory
            __DIR__ . '/ignored/directory/*',
        ]
    )
    /* (...) */

See EasyCodingStandard docs for more configuration options.

IDE integration

For integration with PHPStorm etc. follow instructions in EasyCodingStandard README.

Changelog

For the latest changes see CHANGELOG.md file. We follow Semantic Versioning.

License

This library is open source software licensed under the MIT license.

lmc / coding-standard

Maintainers

Details