Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliangut/php-cs-fixer-config
Opinionated as can be configuration defaults for PHP-CS-Fixer
https://github.com/juliangut/php-cs-fixer-config
Last synced: 23 days ago
JSON representation
Opinionated as can be configuration defaults for PHP-CS-Fixer
- Host: GitHub
- URL: https://github.com/juliangut/php-cs-fixer-config
- Owner: juliangut
- License: bsd-3-clause
- Created: 2022-01-21T20:54:48.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-15T17:08:30.000Z (over 1 year ago)
- Last Synced: 2024-05-02T05:29:05.254Z (6 months ago)
- Language: PHP
- Size: 78.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](http://php.net)
[](https://packagist.org/packages/juliangut/php-cs-fixer-config)
[](https://github.com/juliangut/php-cs-fixer-config/blob/master/LICENSE)
[](https://packagist.org/packages/juliangut/php-cs-fixer-config/stats)
[](https://packagist.org/packages/juliangut/php-cs-fixer-config/stats)
# php-cs-fixer-config
Opinionated as can be configuration defaults for [PHP-CS-Fixer](https://github.com/FriendsOfPhp/PHP-CS-Fixer)
Configurations for PHPUnit assumes version 8.4 or newer is being used
## Installation
### Composer
```
composer require --dev juliangut/php-cs-fixer-config
```
## Usage
Create `.php-cs-fixer.php` file at your project's root directory
```php
ignoreDotFiles(false)
->exclude(['vendor'])
->in(__DIR__)
->name('.php-cs-fixer.php');
return (new FixerConfig80())
->setFinder($finder);
```
Use one of the provided configurations depending on the PHP version you want to support:
* `Jgut\CS\Fixer\FixerConfig73`, PHP >= 7.3
* `Jgut\CS\Fixer\FixerConfig74`, PHP >= 7.4
* `Jgut\CS\Fixer\FixerConfig80`, PHP >= 8.0
* `Jgut\CS\Fixer\FixerConfig81`, PHP >= 8.1
Add `.php-cs-fixer.cache` to your `.gitignore` file
### Configurations
#### Header
Provide a header string, it will be prepended to every file analysed by php-cs-fixer.
The string `{{year}}` will be replaced by the current year, and the string `{{package}}` will be replaced by your package name
```php
return (new FixerConfig80())
->setHeader(<<<'HEADER'
(c) 2021-{{year}} Julián Gutiérrez
This file is part of package {{package}}
HEADER);
```
```diff
--- Original
+++ New
+ *
+ * This file is part of package juliangut/php-cs-fixer-config
+ */
+
declare(strict_types=1);
namespace App;
```
#### PHPUnit
If you work with PHPUnit
```php
return (new FixerConfig80())
->enablePhpUnitRules();
```
#### Doctrine
If you work with Doctrine
```php
return (new FixerConfig80())
->enableDoctrineRules();
```
#### Type Inference
If you're in the middle of "type hinting everything", try enabling type inference rules and let php-cs-fixer migrate types from annotations into properties, parameters and return types
Be aware __these rules are experimental__ and will need human supervision after fixing, so you are advised NOT to permanently enable type inference
```php
return (new FixerConfig80())
->enableTypeInferRules();
```
```diff
--- Original
+++ New
foo = $foo;
$this->bar = $bar;
$this->baz = $baz;
}
- /**
- * @return bool
- *
- public function isBaz()
+ public function isBaz(): bool
{
return $this->baz;
}
}
```
#### Additional rules
If you need to add a few additional rules, this rules can be new or override rules already set, the easiest way is using `setAdditionalRules` method
It is preferred to identify fixers by their class name, anyway using fixer names will work as well
```php
use Jgut\CS\Fixer\FixerConfig80;
use PhpCsFixer\Fixer\FunctionNotation\SingleLineThrowFixer;
return (new FixerConfig80())
->setAdditionalRules([
SingleLineThrowFixer::class => true, // Preferred way
'single_line_throw' => true, // Same as above
]);
```
#### Custom fixer config
If you need more control over applied rules or prefer a cleaner setup, you can easily create your custom fixer config instead of setting additional rules
```php
use Jgut\CS\Fixer\FixerConfig81;
use PhpCsFixer\Fixer\FunctionNotation\SingleLineThrowFixer;
class CustomFixerConfig extends FixerConfig81
{
protected function getFixerRules(): array
{
// Return your custom rules, or add/remove rules from parent's getFixerRules()
return array_merge(
parent::getFixerRules(),
[
SingleLineThrowFixer::class => true, // Preferred way
'single_line_throw' => true, // Same as above
]
);
}
}
```
## Contributing
Found a bug or have a feature request? [Please open a new issue](https://github.com/juliangut/php-cs-fixer-config/issues). Have a look at existing issues before.
See file [CONTRIBUTING.md](https://github.com/juliangut/php-cs-fixer-config/blob/master/CONTRIBUTING.md)
## License
See file [LICENSE](https://github.com/juliangut/php-cs-fixer-config/blob/master/LICENSE) included with the source code for a copy of the license terms.