README

Introduction

A PHP 8.3+ library that provides the shared MATRAUX PHP-CS-Fixer configuration. It exposes a ready-to-use Config for project .php-cs-fixer.dist.php files and public grouped rule sets for custom PHP-CS-Fixer configurations.

Useful for keeping code style, imports, strict typing, class layout, PHPDoc cleanup, indentation, and line endings consistent across multiple PHP packages.

Features

• Ready-to-use PHP-CS-Fixer configuration via Matraux\PhpCodeStyle\Config
• Public grouped rule sets for syntax, imports, operators, functions, PHPDoc, and classes
• PER-CS baseline with automatic PHP migration rules
• Strict typing, strict comparisons, strict parameters, and function alias cleanup
• Import ordering, unused import removal, and fully qualified type normalization
• Class member ordering and class element separation
• Tabs and LF line endings configured by default
• Risky PHP-CS-Fixer rules enabled explicitly

Installation

composer require --dev matraux/php-code-style

Requirements

Examples

Full configuration

Create file .php-cs-fixer.dist.php or .php-cs-fixer.php in root.

<?php declare(strict_types=1);

use Matraux\PhpCodeStyle\Config;

return new Config(__DIR__ . '/src');

Custom PHP-CS-Fixer configuration

<?php declare(strict_types=1);

use Matraux\PhpCodeStyle\RuleSet\Sets\Imports;
use Matraux\PhpCodeStyle\RuleSet\Sets\PhpDoc;
use PhpCsFixer\Config;

$imports = new Imports();
$phpDoc = new PhpDoc();

return (new Config())
	->registerCustomRuleSets([
		$imports,
		$phpDoc,
	])
	->setRules([
		'@PER-CS' => true,
		$imports->getName() => true,
		$phpDoc->getName() => true,
	]);

Run code style check

vendor/bin/php-cs-fixer check

Run code style fixer

vendor/bin/php-cs-fixer fix

Visual Studio Code

Visual Studio Code format setup is documented in Visual Studio Code.

Development

See Development for debug, static analysis, and coding standards.

Support

For bug reports and feature requests, please use the issue tracker.