oyova/php-cs-fixer

A wrapper for PHP CS Fixer.

v1.4.0 2023-09-30 22:36 UTC

Requires

• php: >=7.4,<8.3
• friendsofphp/php-cs-fixer: ^3.14

Requires (Dev)

• symfony/var-dumper: ^5.4

MIT

README

This package is a wrapper for PHP CS Fixer. PHP CS Fixer is used to automatically fix PHP coding standards issues and this package establishes the preferred Oyova rules and simplifies setup.

Installation

Install the package via Composer:

composer require --dev oyova/php-cs-fixer

Setup

In the project root, create a file named .php-cs-fixer.php with the following code:

<?php

return (new Oyova\PhpCsFixer\Setup(__FILE__))
    // ->in(string|array)
    // ->exclude(string|array)
    // ->notName(string|array)
    ->getConfig();

For WordPress, use Oyova\PhpCsFixer\WordPressSetup instead of Oyova\PhpCsFixer\Setup.

Usage

From the project root, run the command vendor/bin/php-cs-fixer fix to fix all configured files or vendor/bin/php-cs-fixer fix path/to/file.php to fix a specific file or directory. Create a bash alias for the command for ease of use (e.g. alias phpfix='vendor/bin/php-cs-fixer fix').