PHP CS Fixer

Install PHP CS Fixer with Composer

When you install PHP CS Fixer with Composer, PhpStorm automatically downloads the necessary scripts, registers them in the IDE, and, optionally, enables and configures the corresponding code inspection.

1. Inside composer.json, add the friendsofphp/php-cs-fixer dependency record to the require or require-dev key. To get code completion for the package name and version, press Ctrl+Space.

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 Alt+Enter and select whether you want to install a specific dependency or all dependencies at once.

Clicking next to the package record in the composer.json editor gutter will take you to the corresponding Settings page where you can configure PHP CS Fixer manually.

Reset PHP CS Fixer configuration

After PHP CS Fixer is initially configured, further modifications in composer.json will not affect the inspection configuration. To apply newer changes, reset the PHP CS Fixer configuration.

1. In the Settings dialog (Ctrl+Alt+S) , navigate to PHP | Quality Tools | PHP CS Fixer.

2. Click next to the Configuration list.

3. In the PHP CS Fixer dialog that opens, empty the PHP CS Fixer path field.

   

4. Update the project Composer dependencies by clicking Update on top of the composer.json editor panel. For more information, refer to Update dependencies.

PhpStorm will perform the PHP CS Fixer configuration anew and thus apply the changes in composer.json.

Configure PHP CS Fixer in PhpStorm

When you install PHP CS Fixer with Composer, PhpStorm automatically detects PHP CS Fixer's executable file in the vendor/bin folder and sets the PHP interpreter configured in the system path to run it.

In Settings (Ctrl+Alt+S) | PHP | Quality Tools | PHP CS Fixer, you can change the default PHP interpreter, set the path to a manually downloaded and installed PHP CS Fixer executable file, or add some options to be passed to PHP CS Fixer when running it in PhpStorm.

• Configuration: in this field, you can change the default PHP interpreter and path to the PHP CS Fixer executable file.

  1. To only change the interpreter, select the required item from the list of local and remote PHP interpreters configured in your project.

  2. To change the path to the PHP CS Fixer executable file, or both the interpreter and the path, click next to the Configuration list to open the PHP CS Fixer dialog and edit the fields there as described on the PHP CS Fixer Dialog reference page.

• Show ignored files: use this setting to exclude files from PHP CS Fixer validation inspection. For more information, refer to the Quality Tools reference page.

• Options: in this area, add the options to run PHP CS Fixer as a PhpStorm inspection with. Edit the fields there as described on the PHP CS Fixer reference page.

Enable the PHP CS Fixer inspection with Composer

You can include the information on the default and custom PHP CS Fixer rulesets inside the scripts section of composer.json. When you install or update project dependencies, the specified rulesets will be detected and the PHP CS Fixer validation inspection will be enabled automatically.

If no ruleset is specified in the scripts section of composer.json, PhpStorm will additionally check the project root to locate the ruleset with the .php_cs or .php_cs.dist default name. If the file is present, it will be automatically selected as the inspection's Custom ruleset.

• In the scripts section of composer.json, add the php-cs-fixer PHP CS Fixer launch command into one of the leaf elements.

  Provide the --rules argument to denote the coding standard used. For example, adding the following record will set the coding standard to PSR1:

  "scripts": { "php-cs-fixer": "php-cs-fixer --rules=@PSR1" }

  Alternatively, provide the --config argument and the path to the ruleset file, which will set the coding standard to Custom:

  "scripts": { "php-cs-fixer": "php-cs-fixer --config=./.php_cs" }

Enable PHP CS Fixer validation in Inspections settings

1. In the Settings dialog (Ctrl+Alt+S) , click Inspections under Editor.

2. On the Inspections page that opens, expand the PHP | Quality Tools node and select the checkbox next to PHP CS Fixer validation.

   

3. On the right-hand pane of the page, configure how PhpStorm handles the PHP CS Fixer inspection output:

   1. Scope: choose the scope to limit the inspection application to.

   2. Severity: choose the severity degree for the inspection. The selected value determines how seriously the detected discrepancies will be treated by PhpStorm and presented in the inspection results.

   3. Highlighting in editor: choose how the issues detected by the inspection are highlighted in the editor.

1. In the main menu, go to Code | Inspect code.

2. In the Specify Inspection Scope dialog that opens, select the inspection profile from the list, or click Configure to open the Inspections dialog and configure a new profile.

   You can also click Configure to check which fixes will be applied within the scope of the selected inspection profile, and make sure that the PHP CS Fixer validation inspection is enabled.

3. View the inspection results in the Problems tool window. Errors and warnings reported by PHP CS Fixer are prefixed with PHP CS Fixer: to distinguish them from PhpStorm internal inspections.

   

Fix issues by using a quick-fix

Upon detecting an issue, PhpStorm highlights it in accordance with the PHP CS Fixer inspection settings.

1. Place the caret at the detected issue and click , or press Alt+Enter.

2. Select PHP CS Fixer: fix the whole file from the popup menu. Note that this will fix all issues detected in the current file.

You can also detect issues in the batch mode, or fix them automatically with code reformatting.

Fix issues with code reformatting

You can fix issues detected by PHP CS Fixer by running the reformat code action.

1. Set PHP CS Fixer as an external formatter in the Quality Tools settings.

   To do so, in the Settings dialog (Ctrl+Alt+S) go to PHP | Quality Tools and select PHP CS Fixer in the External Formatters section.

   

2. Apply Reformat Code to the required file or project scope:

   • For a code fragment or a file opened in the editor, select Code | Reformat Code from the main menu or press Ctrl+Alt+L.

   • For a selected file, directory, or group of files in the Project tool window, select Reformat Code from the context menu or press Ctrl+Alt+L.

1. Put the root directory of your coding standard under the project root.

2. Configure PHP CS Fixer as a PhpStorm inspection.

3. Appoint your coding standard.

4. Make sure that a project profile is selected at the top of the Inspections page. Such profiles are saved in a particular project's .idea directory (for example, $PROJECT_DIR$/.idea/inspectionProfiles). For more information, refer to Configure profiles.

5. On the Version Control page of the Settings dialog, make sure that the .idea directory is put under version control.

1. In the Settings dialog (Ctrl+Alt+S) , navigate to PHP | Quality Tools | PHP CS Fixer.

2. Click the Show ignored files link.

   • To add a file, click and locate the desired file in the dialog that opens.

   • To delete a file from the list and have PHP CS Fixer process it again, select the file and click .

   • To remove all the files from the list, click .