axazara/php-cs

Axa Zara PHP Code style configuration for `php-cs-fixer` based on PSR-12.

Installs: 2 977

Dependents: 6

Suggesters: 0

Security: 0

Stars: 0

Forks: 0

Type:package

v0.1 2023-10-04 17:19 UTC

This package is auto-updated.

Last update: 2024-05-19 03:33:51 UTC


README

This package provides php-cs-fixer configuration applied in Axa Zara PHP projects. This represents the standard code style applied within Axa Zara's PHP project.

Quickstart

Step 1 of 3

Install the package via Composer:

composer require --dev axazara/php-cs

Step 2 of 3

Once package installed, a file .php-cs-fixer.dist.php will be created at the root of your project with the following contents:

<?php

use AxaZara\CS\Finder;
use AxaZara\CS\Config;

// Routes for analysis with `php-cs-fixer`
$routes = ['./src', './tests'];

return Config::createWithFinder(Finder::createWithRoutes($routes));

Change the value of $routes depending on where your project's source code is.

Step 3 of 3

And that's it! You can now find code style violations with the following command:

./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --dry-run

And then completely fix them all with:

./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php

Configuration

You must pass a set of routes to the Finder::createWithRoutes() call. For example, for Laravel projects, this would be:

Finder::createWithRoutes(['./app', './config', './database', './resources', './routes', './tests'])

Also, you can pass a custom set of rules to the Config::createWithFinder() call:

Config::createWithFinder($finder, [
    '@PHP81Migration'   => true,
    'array_indentation' => false
])

License

This is open-sourced software licensed under the MIT License.

Special thanks