php-cs-fixer-config

PHP CS Fixer configuration for AzuyaLabs projects

Installation

Run

composer require --dev azuyalabs/php-cs-fixer-config

Usage

Configuration

If not present, create a configuration file .php-cs-fixer.php in the root of your project with the following contents:

<?php

declare(strict_types=1);

$config = new AzuyaLabs\PhpCsFixerConfig\Config();
$config->getFinder()->in(__DIR__);

return $config;

If it already exists, ensure to update it like above.

You can also override any of the default rules like this if you like to do so:

<?php

declare(strict_types = 1);

$config = new AzuyaLabs\PhpCsFixerConfig\Config();
$config->getFinder()->in(__DIR__);

$defaults = $config->getRules();

$config->setRules(array_merge($defaults, [
    '@Symfony' => false,
]));

return $config;

Add two helper scripts to the Composer configuration file:

  ...
"scripts": {
"cs": "vendor/bin/php-cs-fixer fix -v --diff --dry-run",
"cs-fix": "vendor/bin/php-cs-fixer fix -v",
}
...

Git

Add .php-cs-fixer.cache (this is the cache file created by php-cs-fixer) to .gitignore:

.php-cs-fixer.cache
vendor/

GitLab CI/CD

If you have included the two helper scripts in your composer.json file, you can use those in the GitLab CI configuration of your project.

To add a job that will check the Code Style settings as part of your test stage, include this in your .gitlab-ci.yml file:

cs-check:
    stage: test
    script:
        - composer cs

In case you don't want or have the helper Composer script, replace the above composer cs script with vendor/bin/php-cs-fixer fix -v --diff --dry-run

Fixing Code Style issues

Manually

If you need to fix code styling issues locally, just run:

composer cs-fix

Use composer cs to do a dry-run.

Automatically

For those who like to have code styling issues fixed automatically, you can opt to create a Git pre-commit hook, or have your IDE configured to utilize the PHPCS Fixer binary or the configured Composer scripts.

Code Style

This custom configuration is based on the @PER-CS and @Symfony rulesets, with a few additional enabled rules (e.g. concerning spaces, etc.).

Contributing

Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on GitHub :) Create GitHub Issues for bugs and new features and comment on the ones you are interested in.

If you enjoy what I am making, an extra cup of coffee is very much appreciated :). Your support helps me to put more time into Open-Source Software projects like this.

License

This project is open-sourced software licensed under the MIT License (MIT). Please see LICENSE for more information.