jumptwentyfour/laravel-coding-standards

Coding standards for our PHP applications.

Maintainers

Details

github.com/JumpTwentyFour/laravel-coding-standards

Source

Issues

Installs: 92 070

Dependents: 0

Suggesters: 0

Security: 0

Stars: 8

Watchers: 2

Forks: 1

Open Issues: 2

V3.0.0 2024-07-05 11:33 UTC

Requires

Requires (Dev)

MIT 1d70b1d14bac3d3df8c639f987b55e35eb8c9278

This package is auto-updated.

Last update: 2024-12-05 12:34:24 UTC

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 and copy the following and extend as required:

<?php

declare(strict_types=1);

return ECSConfig::configure()
    ->withSets([getcwd() . '/vendor/jumptwentyfour/php-coding-standards/ecs.php'])
    ->withPaths(
        [
            __DIR__ . '/ecs.php',
            __DIR__ . '/src',
        ]
    );