https://github.com/nexusphp/cs-config
:factory: A factory for custom rulesets for PHP CS Fixer.
https://github.com/nexusphp/cs-config
configuration-factory custom-ruleset php rulesets
Last synced: 8 months ago
JSON representation
:factory: A factory for custom rulesets for PHP CS Fixer.
- Host: GitHub
- URL: https://github.com/nexusphp/cs-config
- Owner: NexusPHP
- License: mit
- Created: 2020-11-27T09:46:37.000Z (about 5 years ago)
- Default Branch: 3.x
- Last Pushed: 2025-02-23T15:16:36.000Z (10 months ago)
- Last Synced: 2025-04-19T19:13:36.907Z (8 months ago)
- Topics: configuration-factory, custom-ruleset, php, rulesets
- Language: PHP
- Homepage:
- Size: 535 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nexus CS Config
[](https://php.net)
[](https://github.com/NexusPHP/cs-config/actions/workflows/build.yml)
[](https://coveralls.io/github/NexusPHP/cs-config?branch=develop)
[](//packagist.org/packages/nexusphp/cs-config)
[](LICENSE)
[](//packagist.org/packages/nexusphp/cs-config)
This library provides a factory for custom rulesets for [`friendsofphp/php-cs-fixer`][1].
[1]: https://github.com/FriendsOfPHP/PHP-CS-Fixer
## Installation
You can add this library as a local, per-project dependency to your project
using [Composer](https://getcomposer.org/):
composer require nexusphp/cs-config
If you only need this library during development, for instance to run your project's test suite,
then you should add it as a development-time dependency:
composer require --dev nexusphp/cs-config
## Configuration
* Create a `.php-cs-fixer.dist.php` at the root of your project:
```php
forProjects();
```
* Include the cache file in your `.gitignore`. By
default, the cache file will be saved in the project root.
```diff
vendor/
+# php-cs-fixer
+.php-cs-fixer.php
+.php-cs-fixer.cache
```
## Advanced Configuration
### Adding Preformatted License Header
You can create a preformatted license header to all PHP files by using the public `forLibrary()` method
instead of `forProjects()`. This method accepts two required arguments (the library name and author) and
two optional arguments (the email address and starting year of license).
* Scenario 1: Providing all arguments
```diff
forProjects();
+return Factory::create(new Nexus82())->forLibrary('My Library', 'John Doe', 'john@doe.com', 2020);
```
This setting will configure a license header similar to below:
```php
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace Nexus\CsConfig;
```
* Scenario 2: Providing only the required arguments
If you opted not to provide any of the optional arguments (i.e., email address, starting license year),
these will not be shown on the license header allowing flexibility on the copyright portion.
```diff
forProjects();
+return Factory::create(new Nexus82())->forLibrary('My Library', 'John Doe');
```
This will give the following license header:
```php
forProjects();
+return Factory::create(new Nexus82(), [
+ 'binary_operator_spaces' => false,
+])->forProjects();
```
### Specifying Options to `PhpCsFixer\Config`
The `Factory` class returns an instance of `PhpCsFixer\Config` and fully supports all of
its properties setup. You can pass an array to the third parameter of `Factory::create()`
containing your desired options.
**Options**
| Key | Allowed Types | Default |
| -------------- | :--------------------------------------: | :----------------------------------: |
| cacheFile | `string` | `.php-cs-fixer.cache` |
| customFixers | `FixerInterface[], iterable, \Traversable` | `[]` |
| finder | `iterable, string[], \Traversable` | default `PhpCsFixer\Finder` instance |
| format | `string` | `txt` |
| hideProgress | `bool` | `false` |
| indent | `string` | `' '` // 4 spaces |
| lineEnding | `string` | `"\n"` |
| isRiskyAllowed | `bool` | `false` |
| usingCache | `bool` | `true` |
| customRules | `array` | `[]` |
```diff
forProjects();
+return Factory::create(new Nexus82(), [], [
+ 'usingCache' => false,
+ 'hideProgress => true,
+])->forProjects();
```
## Customization of Ruleset
What is the purpose of a configuration factory if not able to create a custom ruleset for
an organization-wide usage, right? Well, you are not constrained to use the default rulesets
and putting a long array of overrides. That's pretty nasty.
The way to achieve this is dependent on you but the main idea is creating a new ruleset that
extends `Nexus\CsConfig\Ruleset\AbstractRuleset`. Yup, it's that easy. Then you just need to
provide details for its required four (4) protected properties.
```php
name = 'My Company';
$this->rules = [
'@PSR2' => true,
...
];
$this->requiredPHPVersion = 80200;
$this->autoActivateIsRiskyAllowed = true;
}
}
```
Then, in creating your `.php-cs-fixer.dist.php`, use your own ruleset.
```php
forProjects();
```
## Credits
This project is inspired by and an enhancement of [`ergebnis/php-cs-fixer-config`](https://github.com/ergebnis/php-cs-fixer-config).
## Contributing
Contributions are very much welcome. If you see an improvement or bugfix, open a [PR](https://github.com/NexusPHP/cs-config/pulls) now!