developion/coding-standards

1.1.3 2024-03-30 08:19 UTC

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.51
• pestphp/pest: ^2.34
• phpstan/phpstan-strict-rules: ^1.5
• symplify/easy-coding-standard: ^12.1

MIT

• MarcusGaius

README

Based on PSR12, a few targeted tweaks and fixers are aimed to general consistency of the code.

Requirements

• PHP 8.2+

Installation

composer require --dev developion/coding-standards

ECS

Add ecs.php to the root of your project, and set the content to:

use Developion\CodingStandards\SetList;

$config = require SetList::DEVELOPION;

return $config->withPaths([
		__DIR__ . '<PATH>',
		__FILE__,
	]);

The line __DIR__ . '<PATH>' deserves special attention, as it needs to be configured to point to the code of the project that needs to be checked. If necessary, it can be duplicated as many times as necessary.

PHP CS Fixer

Add .php-cs-fixer.php to the root of your project, and set the content to:

use Developion\CodingStandards\SetList;
use PhpCsFixer\Finder;

$finder = (new Finder())
	->in([
		__DIR__ . '<PATH>',
	])
	->ignoreDotFiles(false)
	->ignoreVCSIgnored(true)
	->exclude([
		__DIR__ . '/vendor',
	])
;

$config = require SetList::PHP_CS_FIXER;

return $config($finder);

Adjust the <PATH> to your code accordingly.

TODO: add VS Code config