exoticca/coding-style

PHP Coding Style rules for Exoticca's projects.

v0.0.1 2024-09-27 09:47 UTC

Requires

• symplify/easy-coding-standard: ^12.1

Requires (Dev)

• phpstan/phpstan: ^1.10
• vimeo/psalm: ^5.24

MIT

• Code style

README

Opinionated linting configuration inspired on Codely's Coding Style.

How to use

Install the package via Composer:

composer require --dev exoticca/coding-style

Create a ecs.php file in the root of your project:

use Exoticca\CodingStyle;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig
    ::configure()
    ->withSets([
        CodingStyle::DEFAULT,
    ])
    ->withPaths([
        __DIR__.'/src',
        __DIR__.'/tests',
    ])
    ->withRootFiles();

Execute the following command to see the suggested changes:

vendor/bin/ecs

To actually fix your code, add --fix:

vendor/bin/ecs --fix

For more information, check the Easy Coding Standard documentation

What it does

Checks the code style of your project using:

• PER Coding Style
• Symfony
• Some custom rules (you can see them here).