Quality Tools

Configuration

Select the required interpreter from the list. The list contains all the currently configured local and remote PHP interpreters. For more information, refer to Configure local PHP interpreters and Configure remote PHP interpreters.

Clicking to the right of the drop-down list opens PHP_CodeSniffer Dialog.

Show ignored files

Click to open the PHP_CodeSniffer Ignored Files dialog, which lists the files that PHP_CodeSniffer skips. PhpStorm suggests adding a new file to the list during inspection when waiting for response from the PHP_CodeSniffer exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, PhpStorm displays its name and location.

• 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_CodeSniffer process it again, select the file and click the Remove file button .

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

Check files with extensions

Provide a comma-separated list of file extensions that should be checked by PHP_CodeSniffer.

Show warnings as...

To have PHP_CodeSniffer report warnings in addition to errors, select the checkbox and choose the severity degree from the list. Clear the checkbox to have only errors reported and suppress reporting warnings.

Show sniff name

Select the checkbox to have the corresponding sniff's name displayed in the editor or the inspection results in addition to the inspection summary.

Installed standard paths

If you are relying on a custom third-party coding standard (for example, Coder or Joomla Coding Standards), you need to integrate it with PHP_CodeSniffer prior to using it. To do this, select the Installed standard paths checkbox, click and select the custom standard installation directory in the dialog that opens.

Coding standard

Appoint the coding standard to apply.

• To use one of the predefined coding standards, select it in the Coding standard list, appoint the coding style to check your code against. The list contains all the coding standards installed inside the main php_codesniffer directory structure.

• To have your code checked against your own previously defined coding standard, choose Custom from the list and provide the path to the ruleset.xml file with your own coding standard. Type the path manually or click and select the relevant folder in the dialog that opens.

Configuration

Select the required interpreter from the list. The list contains all the currently configured local and remote PHP interpreters. For more information, refer to Configure local PHP interpreters and Configure remote PHP interpreters.

Clicking to the right of the drop-down list opens PHP CS Fixer Dialog.

Show ignored files

Click to open the PHP CS Fixer Ignored Files dialog, which lists the files that PHP CS Fixer skips. PhpStorm suggests adding a new file to the list during inspection when waiting for response from the PHP CS Fixer exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, PhpStorm displays its name and location.

• 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 the Remove file button .

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

Allow risky rules for built-in rulesets

Select the checkbox to allow risky rules, that is, the rules that can change code behavior. By default, risky rules are not allowed.

Ruleset

Appoint the ruleset to apply.

• To use one of the predefined rulesets, select it from the drop-down list. The list contains all the rulesets declared inside the main php-cs-fixer directory structure.

• To have your code checked against your own previously defined ruleset, choose Custom from the list and provide the path to the .php_cs or .php_cs.dist file with this ruleset. Type the path manually or click and select the relevant folder in the dialog that opens.

Configuration

Select the required interpreter from the list. The list contains all the currently configured local and remote PHP interpreters. For more information, refer to Configure local PHP interpreters and Configure remote PHP interpreters.

Clicking to the right of the drop-down list opens Laravel Pint Dialog.

Show ignored files

Click to open the Laravel Pint Ignored Files dialog, which lists the files that Laravel Pint skips. PhpStorm suggests adding a new file to the list during inspection when waiting for response from the Laravel Pint exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, PhpStorm displays its name and location.

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

• To delete a file from the list and have Laravel Pint process it again, select the file and click the Remove file button .

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

Reformat only uncommitted files

Select the checkbox to only modify the files that have uncommitted changes.

Path to pint.json

Specify the path to your own pint.json configuration file. pint.json files are optional: they are used to enable/disable specific rules from the predefined Laravel Pint presets, or to reuse custom rulesets from PHP CS Fixer.

Ruleset

Select one of Laravel Pint's predefined group of rules.

Configuration

Select the required interpreter from the list. The list contains all the currently configured local and remote PHP interpreters. For more information, refer to Configure local PHP interpreters and Configure remote PHP interpreters.

Clicking to the right of the drop-down list opens Mess Detector Dialog.

Show ignored files

Click to open the Mess Detector Ignored Files dialog, which lists the files that Mess Detector skips. PhpStorm suggests adding a new file to the list during inspection when waiting for response from the Mess Detector exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, PhpStorm displays its name and location.

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

• To delete a file from the list and have Mess Detector process it again, select the file and click the Remove file button .

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

Options

• To use predefined rules, in the Options area, select the checkboxes next to the validations to be performed.

• To use a custom ruleset:

  1. Create and save one or several ruleset files. A valid ruleset file is an .xml file that contains the <ruleset> root element with the name attribute. For more information about custom rulesets, refer to http://phpmd.org/documentation/creating-a-ruleset.html.

  2. In the Custom rulesets area, click and select the relevant rule definition file in the dialog that opens. When you click OK, a new item is added to the Custom rulesets list, where the Name field shows the ruleset name retrieved from the attribute name within the <ruleset> tag and the File field shows the location of the selected ruleset file.

Configuration

Select the required interpreter from the list. The list contains all the currently configured local and remote PHP interpreters. For more information, refer to Configure local PHP interpreters and Configure remote PHP interpreters.

Clicking to the right of the drop-down list opens Psalm Dialog.

Show ignored files

Click to open the Psalm Ignored Files dialog, which lists the files that Psalm skips. PhpStorm suggests adding a new file to the list during inspection when waiting for response from the Psalm exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, PhpStorm displays its name and location.

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

• To delete a file from the list and have Psalm process it again, select the file and click the Remove file button .

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

Configuration file

Provide the path to the Psalm configuration file. If the file is not present, PhpStorm displays the notification prompting you to create it.

Show info

Select the checkbox to have Psalm report the errors that are at a lower level than the errorLevel specified in the configuration file. If the checkbox is not selected, such errors will be ignored.

Find unused code

Select the checkbox to have Psalm report the located unused code (including unused variables).

Find unused @psalm-suppress annotations

Select the checkbox to have Psalm report all unused @psalm-suppress annotations.

Configuration

Select the required interpreter from the list. The list contains all the currently configured local and remote PHP interpreters. For more information, refer to Configure local PHP interpreters and Configure remote PHP interpreters.

Clicking to the right of the drop-down list opens PHPStan Dialog.

Show ignored files

Click to open the PHPStan Ignored Files dialog, which lists the files that PHPStan skips. PhpStorm suggests adding a new file to the list during inspection when waiting for response from the PHPStan exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, PhpStorm displays its name and location.

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

• To delete a file from the list and have PHPStan process it again, select the file and click the Remove file button .

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

Full project run (batch mode only)

Use the option to select whether the entire project or only its source roots are included in the inspection run scope.

note

The Full project run (batch mode only) option is only applicable when running the inspection in batch mode. If selected, the entire project is included in the inspection run scope; otherwise, only the source roots are included.

Level

Provide the desired Rule Level against which the PHPStan checks are performed. Note that if a configuration file is provided, PhpStorm relies on the level value specified in this file, and the Level field is ignored.

Configuration file

Provide the path to the PHPStan configuration file

Autoload file

Provide the path to the autoloader. Note that if a configuration file is provided, PhpStorm relies on the autoload-file value specified in this file, and the Autoload file field is ignored.

Memory limit

Provide the maximum amount of RAM PHPStan is allowed to allocate. You can either provide an explicit integer value in bytes or use a shorthand notation (500M, 4G, and so on).

External formatters

The following code quality tools can be used as external formatters:

• PHP Code Beautifier and Fixer: select if the PHP_CodeSniffer and PHP Code Beautifier and Fixer tools are configured in the PHP_CodeSniffer section.

• PHP CS Fixer: select if the PHP CS Fixer tool is configured in the PHP CS Fixer section.

• Laravel Pint: select if the Laravel Pint tool is configured in the Laravel Pint section.

• No External Formatter: select to use PhpStorm's built-in code formatting rules. The default option when several or none code quality tools are configured.