serendipity_hq/phpcs-config

Custom configuration for PHP CS Fixer used by Serendipity HQ.

1.2.5 2023-10-07 16:02 UTC

Requires (Dev)

• php: ^7.4|^8.0
• friendsofphp/php-cs-fixer: 3.8.0

MIT

• Adamo Aerendir Crespi

• phpcs
• php cs
• php cs fixer
• phpcs fixer

README

Serendipity HQ PHP CS Fixer Configuration

A predefined configuration used in Serendipity HQ's projects.

Current Status

Do you like this library?
LEAVE A ★

or run
composer global require symfony/thanks && composer thanks
to say thank you to all libraries you use in your current project, this included!

Install monolog-html-line-formatter via Composer

$ composer require serendipity_hq/phpcs-config

This library follows the http://semver.org/ versioning conventions.

How to use Serendipity HQ PHP CS Fixer Config

<?php

// WARNING: This variable is fundamental as the rules array sets the `header_comment` rule and expects the variable exists.
$header = <<<EOF
This file is part of the Serendipity HQ PHP CS Fixer Config.

Copyright (c) Adamo Aerendir Crespi <[e-mail]>.

For the full copyright and license information, please view the LICENSE
file that was distributed with this source code.
EOF;

$rules = include \SerendipityHQ\Integration\PhpCsFixer\SerendipityHQ::SHQ_LIBRARY;

$finder = PhpCsFixer\Finder::create()
->in([
    __DIR__.'/src',
    __DIR__.'/tests'
]);

$config = new PhpCsFixer\Config();
return $config
    ->setFinder($finder)
    ->setUsingCache(true)
    ->setCacheFile(__DIR__.'/var/cache/.php_cs.cache')
    ->setRiskyAllowed(true)
    ->setRules($rules);

To change the rules or their configuration on a per-project basis, simply edit the $rule variable and then pass it to the Config::setRues() method.

Do you like this library?
LEAVE A ★

or run
composer global require symfony/thanks && composer thanks
to say thank you to all libraries you use in your current project, this included!