https://github.com/stickeeuk/php-cs-fixer-config
Provides a PHP CS Fixer config for Stickee projects.
https://github.com/stickeeuk/php-cs-fixer-config
php php-cs-fixer
Last synced: 10 months ago
JSON representation
Provides a PHP CS Fixer config for Stickee projects.
- Host: GitHub
- URL: https://github.com/stickeeuk/php-cs-fixer-config
- Owner: stickeeuk
- License: mit
- Created: 2022-11-01T15:29:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T17:09:23.000Z (over 1 year ago)
- Last Synced: 2025-05-05T11:44:15.938Z (about 1 year ago)
- Topics: php, php-cs-fixer
- Language: PHP
- Homepage:
- Size: 91.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# stickee PHP CS Fixer config
Provides a [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) config for stickee projects.
## Installation
```shell
composer require --dev stickee/php-cs-fixer-config
cp vendor/stickee/php-cs-fixer-config/dist/.php-cs-fixer.php .php-cs-fixer.php
```
You must commit the `.php-cs-fixer.php` config file.
You must add `.php-cs-fixer.cache` to your `.gitignore` file.
## Usage
```shell
vendor/bin/php-cs-fixer fix
```
### Overrides
You can override any of the rules or add your own by adding them to the `$overrideRules` array in the `.php-cs-fixer.php` file.
See [here](https://mlocati.github.io/php-cs-fixer-configurator) for a detailed description of available rules and their options.
#### Example
This has already been done for you with the `ordered_class_elements` rule which has been reset to the `PSR12` value of `use_traits` only.
This has been added to help PR reviewers see only what has been changed when linting your project and not elements that have been re-ordered.
Once you are happy that your project has been linted correctly you may remove this override to use the stickee settings for this rule which are stricter and order more elements.
### CI
An example GitHub action file is included at `vendor/stickee/php-cs-fixer-config/dist/.github/workflows/php-cs-fixer.yaml`.
This will run PHP CS Fixer on PRs and new commits to those PRs.
## Rules
The available RuleSets can be found at `vendor/stickee/php-cs-fixer-config/src/RuleSet/`.
You can probably \[ctrl\] + click the class in the `.php-cs-fixer.php` file to get to it in your editor.
### Web description (prettier)
You can use either https://mlocati.github.io/php-cs-fixer-configurator/#version:3.2 or https://cs.symfony.com/doc/rules/index.html to see what the rules are doing.
### CLI description (faster)
Alternatively you can run `vendor/bin/php-cs-fixer describe `.
## Credits
### https://github.com/Visual-Craft/php-cs-fixer-config
for inspiration on how to create a custom config for PHP CS Fixer since there's no built-in way to do it.
### stickeerehan
for his earlier work on PHP Code Styles so I didn't have to start from scratch.
### The "supermarket mobiles" developers
for reviewing the _many_ PRs that finalised the rules that we use.
### The members of the #codestyle Slack channel
for caring about code styles.