Rector

tip

Before you start, make sure Composer is installed on your machine and initialized in the current project as described in Composer dependency manager.

1. Inside composer.json, add the rector/rector dependency record to the require or require-dev key. Press CtrlSpace to get code completion for the package name and version.

   "require-dev": {
     "rector/rector": "^0.15.13"
   },

2. Do one of the following:

   • Click the Install shortcut link on top of the editor panel.

   • If the Non-installed Composer packages inspection is enabled, PhpStorm will highlight the declared dependencies that are not currently installed. Press AltEnter and select whether you want to install a specific dependency or all dependencies at once.

For more information about installing Rector, refer to Rector documentation.

1. Add a rector.php template file to the project root by either of the following:

   • Right-click the root folder in the Project tool window and select New | rector.php File from the context menu.

     PhpStorm invokes a rector init action, which creates a rector.php file in the same way as Rector's vendor/bin/rector init command executed from the command line would do.

   • Search and apply the rector init action from the search window (CtrlShift0A).

     

   • Run the rector init command from the Terminal tool window.

     vendor/bin/rector init

2. Edit the generated rector.php file to specify which Rector rule or rule sets you need. Press CtrlSpace to get code completion suggestions.

   

• In the Project tool window, select the file or folder to run Rector on and choose Run | <File or folder name> (Rector) from the context menu of the selection:

  

  PhpStorm generates a default run configuration and runs the vendor/bin/rector process --dry-run command on the scope specified in the configuration.

1. Open rector.php in the editor.

2. Click in the gutter and select Run '<project name>' (Rector) from the context menu. Alternatively, press CtrlShiftF10 from anywhere in the file.

   

   If you have $rectorConfig->paths defined in your rector.php file, then Rector runs on the specified scope of folders. Otherwise, the run configuration path is automatically set to the src/ folder in the project root.

You can create a custom run configuration or edit an existing default one—for example, to pass additional arguments to the vendor/bin/rector process command.

1. In the Project tool window, select the file or folder and choose More Run/Debug | Modify Run Configuration | <File or folder name> (Rector) from the context menu.

   Alternatively, choose Run | Edit Configurations from the main menu, then click and choose Rector from the list.

2. In the Rector configuration dialog that opens, edit the fields as required.

1. In the Changes tab, click a file from the list to open it and preview the suggested changes in the diff viewer.

   

2. To apply the changes, select checkboxes for the relevant files in the Run tool window and click Apply.