jumptwentyfour/laravel-coding-standards

Coding standards for our PHP applications.

v2.5.0 2024-03-12 09:58 UTC

Requires

• php: ^7.2|^8.0
• jumptwentyfour/php-coding-standards: ^2.2
• larastan/larastan: ^2.7.0
• laravel/framework: ^9.0|^10.0|^11.0
• nikic/php-parser: ^4.0

Requires (Dev)

• phpunit/phpunit: ^9.3

MIT

• Alex Williams
• Daniel Newns

README

At Jump24 we pride ourselves on keeping our coding standards under tight control, this is why we built this package.

Installation

To install this package, simply use composer:

composer require jumptwentyfour/laravel-coding-standards

Setup

Once installed you will have access to our PHPStan configuration file, which you can easily add to your phpstan.neon:

includes:
    - ./vendor/jumptwentyfour/laravel-coding-standards/phpstan.neon

Running

To run the code standard checks, simply run the following command:

./vendor/bin/ecs check

This will run the configured code standard checks for you, giving you feedback on where your code is and what improvements you need to implement

Extending

These code standards are extendable, all you need to do is create your own ecs.php in the root directory of your project:

<?php

declare(strict_types=1);

use JumpTwentyFour\PhpCodingStandards\Support\ConfigHelper;
use Symplify\EasyCodingStandard\Config\ECSConfig;
use Symplify\EasyCodingStandard\ValueObject\Option;

return static function (ECSConfig $ecsConfig): void {
    $ecsConfig->import(__DIR__ . '/vendor/jumptwentyfour/laravel-coding-standards/ecs.php');

    $ecsConfig->paths([
        __DIR__ . '/app',
        __DIR__ . '/config',
        __DIR__ . '/database',
        __DIR__ . '/routes',
        __DIR__ . '/tests',
    ]);
    
    $ecsConfig->skip(array_merge(ConfigHelper::make()->getParameter(Option::SKIP), [
        UnusedParameterSniff::class => [
            __DIR__ . '/app/Console/Kernel.php',
            __DIR__ . '/app/Exceptions/Handler.php',
        ],
        'Unused parameter $attributes.' => [
            __DIR__ . '/database/*.php',
        ],
        CamelCapsFunctionNameSniff::class => [
            '/tests/**',
        ],
    ]));
};