phlak/coding-standards

A pre-defined set of coding standards for PHP CS Fixer.

4.0.0 2024-12-11 03:59 UTC

Requires

• php: ^8.1
• friendsofphp/php-cs-fixer: ^3.0

Requires (Dev)

• phpstan/phpstan: ^2.0
• symfony/var-dumper: ^6.0 || ^7.0
• yoast/phpunit-polyfills: ^3.0

Suggests

• symfony/console: Required for initialize command

MIT

• Chris Kankiewicz

README

A pre-defined set of coding standards for PHP CS Fixer
Created by Chris Kankiewicz (@phlak.dev)

Requirements

• PHP >= 8.1

Installation

composer require --dev phlak/coding-standards

Usage

After installation you may initialze the coding standards configuration with the provided cs executable.

composer exec cs init

Alternatively you may manually create a .php-cs-fxer.dist.php file in the root folder with the following contents.

<?php

require __DIR__ . '/vendor/autoload.php';

$finder = PhpCsFixer\Finder::create()->in([
    // List of paths you wish to include
]);

return PHLAK\CodingStandards\ConfigFactory::make($finder);

Add the paths you wish to be coverd to the array.

Now you may run php-cs-fixer as normal.

Add / Override Rules

You can add additional rules or override pre-defined ones by passing them as the second parameter to the ConfigFactory::make() method. These rules will be merged with the pre-defined rules.

return PHLAK\CodingStandards\ConfigFactory::make($finder, [
    // Your additional rules here...
]);

Additional Configuration

Additional configuration can be achieved by chaining methods onto the ConfigFactory::make() method.

return PHLAK\CodingStandards\ConfigFactory::make($finder)
    ->setIndent("\t")
    ->setLineEnding("\r\n")
    ->setRiskyAllowed();

Changelog

A list of changes can be found on the GitHub Releases page.

Troubleshooting

For general help and support join our GitHub Discussions or reach out on Bluesky.

Please report bugs to the GitHub Issue Tracker.

Copyright

This project is licensed under the MIT License.