https://github.com/romanzipp/php-cs-fixer-config
Personal PHP-CS-Fixer wrapper & Custom rules & preset management inlcuding PHPStorm integration
https://github.com/romanzipp/php-cs-fixer-config
php php-cs-fixer php7 php8 phpstorm styling syntax
Last synced: over 1 year ago
JSON representation
Personal PHP-CS-Fixer wrapper & Custom rules & preset management inlcuding PHPStorm integration
- Host: GitHub
- URL: https://github.com/romanzipp/php-cs-fixer-config
- Owner: romanzipp
- License: mit
- Created: 2021-01-15T16:12:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-02T10:20:02.000Z (over 1 year ago)
- Last Synced: 2025-02-28T02:09:28.712Z (over 1 year ago)
- Topics: php, php-cs-fixer, php7, php8, phpstorm, styling, syntax
- Language: PHP
- Homepage:
- Size: 900 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# PHP-CS-Fixer Configuration
[](https://packagist.org/packages/romanzipp/php-cs-fixer-config)
[](https://packagist.org/packages/romanzipp/php-cs-fixer-config)
[](https://packagist.org/packages/romanzipp/php-cs-fixer-config)
[](https://github.com/romanzipp/PHP-CS-Fixer-Config/actions)
Personal [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) wrapper, preset management and custom rules.
## Installation
```
composer require romanzipp/php-cs-fixer-config --dev
```
**Notice**: You also need to [install the PHP-CS-Fixer package](https://github.com/FriendsOfPHP/PHP-CS-Fixer#installation) itself if you need a local installation with executable in your `vendor/bin` folder.
## Usage
This package has been created to streamline configuration management for multiple projects and keeping PHP CS Fixer rules up to date.
#### `.php-cs-fixer.dist.php`
```php
return romanzipp\Fixer\Config::make()
->in(__DIR__)
->preset(
new romanzipp\Fixer\Presets\PrettyPHP()
)
->out();
```
## Available Presets
- [**PrettyPHP**](src/Presets/PrettyPHP.php)
- [**PrettyLaravel**](src/Presets/PrettyLaravel.php) (extends [PrettyPHP](src/Presets/PrettyPHP.php))
You can easily create your own presets by extending the [**AbstractPreset**](src/Presets/AbstractPreset.php) class.
### Overriding presets
In case you only need some tweaks for specific projects - which won't deserve an own preset - there are various methods you can make us of.
```php
$config = romanzipp\Fixer\Config::make();
$config->allowRisky(true); // Allow risky rules.
$config->withRules(['...']); // Set additional rules
$config->exclude(['...']); // Add single or many files to the list of excluded files.
$config->excludeDirectories(['...']); // Add single or many directories to the list of excluded directories.
```
## Available Rules
### Convert PHPDoc Classes to FQCN
```php
$fixer->withRules([
'RomanZipp/phpdoc_fqcn' => true,
]);
```
Show code sample
#### Bad
```php
use App\Foo;
use App\Bar;
/**
* @param Foo $foo
* @return Bar[]
*/
function foo(Foo $foo): array {}
```
#### Good
```php
use App\Foo;
/**
* @param \App\Foo $foo
* @return \App\Bar[]
*/
function foo(Foo $foo): array {}
```
## Advanced Usage
### Access the config and finder instances
```php
return romanzipp\Fixer\Config::make()
// ...
->finderCallback(static function (PhpCsFixer\Finder $finder): void {
// ...
})
->configCallback(static function (PhpCsFixer\Config $config): void {
$config->registerCustomFixers();
// ...
})
// ...
->out();
```
## PHPStorm Configuration
### Prequisites
You will need to install PHP CS Fixer globally on your system because PHPStorm [does not allow](https://youtrack.jetbrains.com/issue/WI-56557) you to set the php-cs-fixer executable on a per-project basis or relative to the project path.
```shell
composer global require friendsofphp/php-cs-fixer
```
### 1. Enable Inspection
### 2. Select ruleset .php-cs-fixer.dist.php file `[...]`
Unfortunately you have to repeat this process for every project since [there is a bug in PHPStorm](https://youtrack.jetbrains.com/issue/WI-56557) which prevents users from using relative paths for the `.php-cs-fixer.dist.php` configuration or executable file.
Another theoretical approach to this issue is to create a unified ruleset file in your users .composer folder. This has the downside on only having one single ruleset.
### 3. Navigate to Quality Tools by clicking on the "PHP CS Fixer" link
### 4. Select PHP-CS-Fixer executable
