rector/docs/rector_recipe.md
Damian Dziaduch 38c8e6a007
Alter command name
This change will suggest to use command given in the output of the vendor/bin/rector
2020-05-11 10:27:32 +02:00

53 lines
1.2 KiB
Markdown

# Generating your own Rector from a Recipe
## 1. Configure a Rector Recipe in `rector.yaml`
```yaml
# rector.yaml
parameters:
rector_recipe:
# run "bin/rector create" to create a new Rector + tests from this config
package: "Celebrity"
name: "SplitToExplodeRector"
node_types:
# put the main node first, it is used to create the namespace
- "Assign"
description: "Removes unneeded $a = $a assignments"
code_before: >
<?php
class SomeClass
{
public function run()
{
$a = $a;
}
}
code_after: >
<?php
class SomeClass
{
public function run()
{
}
}
source: # e.g. link to RFC or headline in upgrade guide, 1 or more in the list
- ""
set: "celebrity" # e.g. symfony30, target config to append this rector to
```
## 2. Generate it
```bash
vendor/bin/rector create-rector
```
There is also a shortcut command:
```bash
vendor/bin/rector c
```
That's it :)