README

PHP Coding Standards

Documentation

Installation:

To install the package via composer, use the following:

$ composer require clivern/phpcs --dev

Place a file named .php-cs-fixer.dist.php that has following content in your project's root directory.

<?php

declare(strict_types=1);

use Clivern\CodingStandards\Rules;
use PhpCsFixer\Config;
use PhpCsFixer\Finder;


$fileHeaderComment = <<<COMMENT
This file is part of Clivern/phpcs - PHP Coding Standards
(c) Clivern <hello@clivern.com>
COMMENT;

$finder = Finder::create()
    ->name('.php_cs.dist')
    ->in(__DIR__)
    ->exclude('vendor');

$overrides = [
    'declare_strict_types' => true,
];

return (new Config())
    ->setFinder($finder)
    ->setRiskyAllowed(true)
    ->setRules(Rules::PHP72($fileHeaderComment, $overrides));

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, phpcs is maintained under the Semantic Versioning guidelines and release process is predictable and business-friendly.

See the Releases section of our GitHub project for changelogs for each release version of phpcs. It contains summaries of the most noteworthy changes made in each release.

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/clivern/phpcs/issues

Security Issues

If you discover a security vulnerability within phpcs, please send an email to hello@clivern.com

Contributing

We are an open source, community-driven project so please feel free to join us. see the contributing guidelines for more details.

License

phpcs is authored and maintained by @clivern.

clivern / phpcs

Maintainers

Details