phlak/coding-standards

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

Fund package maintenance!
PHLAK
Paypal

2.0.0 2021-05-27 22:58 UTC

README

Join our Community Become a Sponsor One-time Donation
Latest Stable Version Total Downloads License GitHub branch checks state

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

Requirements

  • PHP >= 7.2

Installation

composer require --dev phlak/coding-standards

Usage

After installing in your project, create a .php_cs.dist 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);

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 Twitter.

Please report bugs to the GitHub Issue Tracker.

Copyright

This project is licensed under the MIT License.