mirror_php/rector
1
0
Fork 0
mirror of https://github.com/rectorphp/rector.git synced 2025-01-17 13:28:18 +01:00
Code Issues Projects Releases Wiki Activity

README: add --with-style option [skip ci]

Browse Source
This commit is contained in:
Tomas Votruba 2018-07-01 18:37:04 +02:00
parent 5154cc81ec
commit 0de4370b41
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -143,19 +143,14 @@ You don't have to always write PHP code. Many projects change only classes or me
- [Dynamic Rectors](/docs/DynamicRectors.md)
- [Turn Magic to Methods](/docs/MagicDisclosureRectors.md)
## Coding Standards are Outsourced
## How to Apply Coding Standards?
This package has no intention in formatting your code, as **coding standard tools handle this much better**. We prefer [EasyCodingStandard](https://github.com/Symplify/EasyCodingStandard) with Rector's prepared set:
Rector uses [EasyCodingStandard](https://github.com/Symplify/EasyCodingStandard) to improve the code style of changed files, like import namespaces, make 1 empty line between class elements etc.
It's always better to use own project's prepared set, but if you don't have the option yet, just use `--with-style` option to handle these basic cases:
```bash
# install
composer require --dev symplify/easy-coding-standard
# check
vendor/bin/ecs check --config vendor/rector/rector/ecs-after-rector.yml
# fix
vendor/bin/ecs check --config vendor/rector/rector/ecs-after-rector.yml --fix
vendor/bin/rector process src --with-style
```
## More Detailed Documentation