Codesniffer Phpstorm

Install Php Codesniffer Phpstorm
Phpstorm Codesniffer Drupal
Phpstorm Codesniffer Xml
Code Sniffer Phpstorm Windows
Code Sniffer Phpstorm Docker
Phpstorm Codesniffer Ruleset

Double check your settings in Settings → Lang&Fw → PHP → Code Sniffer → Configuration → Local →. → Code Sniffer (phpcs) path and make sure you're using local vendor folder and not anything else. Simioluwatomi commented on Jul 30, 2018 I actually have this same issue. PHPCodeSniffer path: C:UsersMYUSERNAMEAppDataRoamingComposervendorbinphpcs.bat. If I run this batch file from cmd.exe it works fine. Yet if I click 'Validate' next to the phpcs path, I get the message 'Can not run PHPCodeSniffer'. Use php CodeSniffer commands, pointed towards your xml file, to sniff the code using the new ruleset.

The page is available only when the PHP plugin is enabled. The PHP plugin is bundled with PhpStorm and activated by default. If the plugin is disabled, enable it on the Settings/Preferences | Plugins page as described in Managing plugins.

PHP_CodeSniffer

In this section, choose the PHP_CodeSniffer script to use.

Item	Description
Configuration	Choose the code quality tool script: To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter. To use a local script, choose Local. In this case the local code quality tool will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for code quality tool because PhpStorm runs a script (phpcs.bat for Windows or phpcs for Linux and macOS) that contains a path to a PHP engine. To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.
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 .

Item

Description

Configuration

Choose the code quality tool script:

To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
To use a local script, choose Local. In this case the local code quality tool will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for code quality tool because PhpStorm runs a script (phpcs.bat for Windows or phpcs for Linux and macOS) that contains a path to a PHP engine.
To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.

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 .

PHP_CodeSniffer Dialog

The dialog opens when you click next to the Configuration list on the PHP_CodeSniffer page.

Use this dialog to configure local PHP_CodeSniffer scripts or scripts associated with remote PHP interpreters as well as configure PHP_CodeSniffer's behaviour. See PHP_CodeSniffer for details.

Item	Description
PHP_CodeSniffer path	In this field, specify the location of the PHP_CodeSniffer script: phpcs.bat for Windows or phpcs for Linux and macOS. If the script is associated with a PHP interpreter, PhpStorm detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens. To check that the specified path to phpcs.bat or phpcs ensures interaction between PhpStorm and PHP_CodeSniffer, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the `phpcs --version` command. If validation passes successfully, PhpStorm displays the information on the detected PHP_CodeSniffer version. The directory containing the PHP engine executable must be added to the system `path`. This allows code quality tool scripts execute calls to the system-wide PHP engine.
Interpreter	The field shows the chosen PHP interpreter to use the PHP_CodeSniffer from.
Tool process timeout	In this field, specify how long you want PhpStorm to wait for a result from PHP_CodeSniffer. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the PHP_CodeSniffer process behavior depending on the configuration of your computer and the rule sets used.
PHP Code Beautifier and Fixer Settings	In this area, provide the path to the PHP Code Beautifier and Fixer tool in the Path to phpcbf field. Type the path manually or click and select the path in the dialog that opens.

PHP Mess Detector

In this section, choose the Mess Detector script to use.

Item	Description
Configuration	Choose the Mess Detector script: To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter. To use a local script, choose Local. In this case the local Mess Detector will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for Mess Detector because PhpStorm runs a script (phpmd.bat for Windows or phpmd for Linux and macOS) that contains a path to a PHP engine. To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.
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 .

Item

Description

Configuration

Choose the Mess Detector script:

To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
To use a local script, choose Local. In this case the local Mess Detector will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for Mess Detector because PhpStorm runs a script (phpmd.bat for Windows or phpmd for Linux and macOS) that contains a path to a PHP engine.
To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.

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 .

Mess Detector Dialog

The dialog opens when you click next to the Configuration list on the Mess Detector page.

Use this dialog to configure local Mess Detector scripts or scripts associated with remote PHP interpreters as well as configure Mess Detector's behaviour. See PHP Mess Detector for details.

Item Description

Mess Detector path

Item	Description
Mess Detector path	In this field, specify the location of the Mess Detector script: phpmd.bat for Windows or phpmd for Linux and macOS. If the script is associated with a PHP interpreter, PhpStorm detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens. To check that the specified path to phpmd.bat or phpmd ensures interaction between PhpStorm and Mess Detector, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the `phpmd --version` command. If validation passes successfully, PhpStorm displays the information on the detected Mess Detector version. The directory containing the PHP engine executable must be added to the system `path`. This allows code quality tool scripts execute calls to the system-wide PHP engine.
Interpreter	The field shows the chosen PHP interpreter to use the Mess Detector from.
Tool process timeout	In this field, specify how long you want PhpStorm to wait for a result from Mess Detector. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the Mess Detector process behavior depending on the configuration of your computer and the rule sets used.

In this field, specify the location of the Mess Detector script: phpmd.bat for Windows or phpmd for Linux and macOS.

If the script is associated with a PHP interpreter, PhpStorm detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens.

To check that the specified path to phpmd.bat or phpmd ensures interaction between PhpStorm and Mess Detector, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the phpmd --version command. If validation passes successfully, PhpStorm displays the information on the detected Mess Detector version.

The directory containing the PHP engine executable must be added to the system path. This allows code quality tool scripts execute calls to the system-wide PHP engine.

Interpreter The field shows the chosen PHP interpreter to use the Mess Detector from.

Tool process timeout In this field, specify how long you want PhpStorm to wait for a result from Mess Detector. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the Mess Detector process behavior depending on the configuration of your computer and the rule sets used.

PHP CS Fixer

In this section, choose the PHP CS Fixer script to use.

Item	Description
Configuration	Choose the PHP CS Fixer script: To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter. To use a local script, choose Local. In this case the local PHP CS Fixer will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for PHP CS Fixer because PhpStorm runs a script (php-cs-fixer.bat for Windows or php-cs-fixer for Linux and macOS) that contains a path to a PHP engine. To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.
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 .

Item

Description

Configuration

Choose the PHP CS Fixer script:

To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
To use a local script, choose Local. In this case the local PHP CS Fixer will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for PHP CS Fixer because PhpStorm runs a script (php-cs-fixer.bat for Windows or php-cs-fixer for Linux and macOS) that contains a path to a PHP engine.
To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.

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 .

PHP CS Fixer Dialog

The dialog opens when you click next to the Configuration list on the PHP CS Fixer page.

Use this dialog to configure local PHP CS Fixer scripts or scripts associated with remote PHP interpreters as well as configure PHP CS Fixer's behaviour. See PHP CS Fixer for details.

Item Description

PHP CS Fixer path

Item	Description
PHP CS Fixer path	In this field, specify the location of the PHP CS Fixer script: php-cs-fixer.bat for Windows or php-cs-fixer for Linux and macOS. If the script is associated with a PHP interpreter, PhpStorm detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens. To check that the specified path to php-cs-fixer.bat or php-cs-fixer ensures interaction between PhpStorm and PHP CS Fixer, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the `php-cs-fixer --version` command. If validation passes successfully, PhpStorm displays the information on the detected PHP CS Fixer version. The directory containing the PHP engine executable must be added to the system `path`. This allows code quality tool scripts execute calls to the system-wide PHP engine.
Interpreter	The field shows the chosen PHP interpreter to use the PHP CS Fixer from.
Tool process timeout	In this field, specify how long you want PhpStorm to wait for a result from PHP CS Fixer. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the PHP CS Fixer process behavior depending on the configuration of your computer and the rule sets used.

In this field, specify the location of the PHP CS Fixer script: php-cs-fixer.bat for Windows or php-cs-fixer for Linux and macOS.

To check that the specified path to php-cs-fixer.bat or php-cs-fixer ensures interaction between PhpStorm and PHP CS Fixer, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the php-cs-fixer --version command. If validation passes successfully, PhpStorm displays the information on the detected PHP CS Fixer version.

The directory containing the PHP engine executable must be added to the system path. This allows code quality tool scripts execute calls to the system-wide PHP engine.

Interpreter The field shows the chosen PHP interpreter to use the PHP CS Fixer from.

Tool process timeout In this field, specify how long you want PhpStorm to wait for a result from PHP CS Fixer. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the PHP CS Fixer process behavior depending on the configuration of your computer and the rule sets used.

Psalm

In this section, choose the Psalm script to use.

Item	Description
Configuration	Choose the Psalm script: To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter. To use a local script, choose Local. In this case the local Psalm will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for Psalm because PhpStorm runs a script (psalm.bat for Windows or psalm for Linux and macOS) that contains a path to a PHP engine. To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.
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 .

Item

Description

Configuration

Choose the Psalm script:

To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
To use a local script, choose Local. In this case the local Psalm will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for Psalm because PhpStorm runs a script (psalm.bat for Windows or psalm for Linux and macOS) that contains a path to a PHP engine.
To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.

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 .

Psalm Dialog

The dialog opens when you click next to the Configuration list on the Psalm page.

Use this dialog to configure local Psalm scripts or scripts associated with remote PHP interpreters as well as configure Psalm's behaviour. See Psalm for details.

Item Description

Psalm path

Item	Description
Psalm path	In this field, specify the location of the Psalm script: psalm.bat for Windows or psalm for Linux and macOS. If the script is associated with a PHP interpreter, PhpStorm detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens. To check that the specified path to psalm.bat or psalm ensures interaction between PhpStorm and Psalm, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the `psalm --version` command. If validation passes successfully, PhpStorm displays the information on the detected Psalm version. The directory containing the PHP engine executable must be added to the system `path`. This allows code quality tool scripts execute calls to the system-wide PHP engine.
Interpreter	The field shows the chosen PHP interpreter to use the Psalm from.
Tool process timeout	In this field, specify how long you want PhpStorm to wait for a result from Psalm. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the Psalm process behavior depending on the configuration of your computer and the rule sets used.

In this field, specify the location of the Psalm script: psalm.bat for Windows or psalm for Linux and macOS.

To check that the specified path to psalm.bat or psalm ensures interaction between PhpStorm and Psalm, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the psalm --version command. If validation passes successfully, PhpStorm displays the information on the detected Psalm version.

The directory containing the PHP engine executable must be added to the system path. This allows code quality tool scripts execute calls to the system-wide PHP engine.

Interpreter The field shows the chosen PHP interpreter to use the Psalm from.

Tool process timeout In this field, specify how long you want PhpStorm to wait for a result from Psalm. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the Psalm process behavior depending on the configuration of your computer and the rule sets used.

PHPStan

In this section, choose the PHPStan script to use.

Item	Description
Configuration	Choose the PHPStan script: To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter. To use a local script, choose Local. In this case the local PHPStan will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for PHPStan because PhpStorm runs a script (phpstan.bat for Windows or phpstan for Linux and macOS) that contains a path to a PHP engine. To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.
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 .

Item

Description

Configuration

Choose the PHPStan script:

To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
To use a local script, choose Local. In this case the local PHPStan will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for PHPStan because PhpStorm runs a script (phpstan.bat for Windows or phpstan for Linux and macOS) that contains a path to a PHP engine.
To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.

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 .

PHPStan Dialog

The dialog opens when you click next to the Configuration list on the PHPStan page.

Use this dialog to configure local PHPStan scripts or scripts associated with remote PHP interpreters as well as configure PHPStan's behaviour. See PHPStan for details.

Item Description

PHPStan path

Item	Description
PHPStan path	In this field, specify the location of the PHPStan script: phpstan.bat for Windows or phpstan for Linux and macOS. If the script is associated with a PHP interpreter, PhpStorm detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens. To check that the specified path to phpstan.bat or phpstan ensures interaction between PhpStorm and PHPStan, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the `phpstan --version` command. If validation passes successfully, PhpStorm displays the information on the detected PHPStan version. The directory containing the PHP engine executable must be added to the system `path`. This allows code quality tool scripts execute calls to the system-wide PHP engine.
Interpreter	The field shows the chosen PHP interpreter to use the PHPStan from.
Tool process timeout	In this field, specify how long you want PhpStorm to wait for a result from PHPStan. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the PHPStan process behavior depending on the configuration of your computer and the rule sets used.

In this field, specify the location of the PHPStan script: phpstan.bat for Windows or phpstan for Linux and macOS.

To check that the specified path to phpstan.bat or phpstan ensures interaction between PhpStorm and PHPStan, that is, the tool can be launched from PhpStorm and PhpStorm will receive problem reports from it, click the Validate button. This validation is equal to running the phpstan --version command. If validation passes successfully, PhpStorm displays the information on the detected PHPStan version.

The directory containing the PHP engine executable must be added to the system path. This allows code quality tool scripts execute calls to the system-wide PHP engine.

Interpreter The field shows the chosen PHP interpreter to use the PHPStan from.

Tool process timeout In this field, specify how long you want PhpStorm to wait for a result from PHPStan. If the timeout is exceeded, the process is terminated to prevent excessive CPU and memory usage. This lets you fine tune the PHPStan process behavior depending on the configuration of your computer and the rule sets used.

From Joomla! Documentation

English • ‎français • ‎русский • ‎Türkçe

Install Php Codesniffer Phpstorm

31. Installation of PHP Code Sniffer (phpcs)
63. IDE Integration
- 6.1PhpStorm
  - 6.1.1Set Path to Code Sniffer
  - 6.1.2PHP PSR-0, PSR-1 and PSR-2

A Nose For Joomla

This is a custom coding standard for the PHP CodeSniffer that attempts to codify and enforce the Joomla coding standards. This article covers how to set the automatic code style checker. It consists of three steps:

Install PHP CodeSniffer (phpcs).
Clone the Joomla Code Style (for use with for phpcs).
Configure your IDE to work with PHP CodeSniffer and Joomla Code Style.

PHP Code Sniffer in action

Why?

Coherent and consistent coding practice makes the files look more professional. Conflicting styles in the same project (or worse, the same file) not only look sloppy, they encourage further sloppiness.
When all code complies with the same standard, bad code is easier for everyone to spot.
It makes it easier for someone new to a particular file in the project to find and fix errors or extend functionality.
If there is no consistent standard maintained, sometimes developers will reformat the code to suit themselves. This causes a wide range of changes in the code repository. If there is a later problem, a significant change could be lost in the chaff produced by a diff.

1. Installation of PHP Code Sniffer (phpcs)

Composer

PHP Code Sniffer is available via Composer. It can be installed system-wide with the following command:
composer global require squizlabs/php_codesniffer '~3.5' On Linux PHP Code Sniffer (phpcs) will be installed under your user folder:

Symbolic Link: ~/.composer/vendor/bin/phpcs
The file: ~/.composer/vendor/squizlabs/php_codesniffer/scripts/phpcs

To create that symbolic link, use on the command line: $ sudo ln -s ~/.config/composer/vendor/squizlabs/php_codesniffer/scripts /usr/bin/phpcs

or (for example OpenSuse)

Symbolic Link: ~/.config/composer/vendor/bin/phpcs
The file: ~/.config/composer/vendor/squizlabs/php_codesniffer/scripts/phpcs

On Windows PHP Code Sniffer (phpcs) will be installed under your user folder:

Symbolic Link: c:UsersUsernameAppDataRoamingComposervendorbinphpcs
The file: c:UsersUsernameAppDataRoamingComposervendorsquizlabsphp_codesnifferscriptsphpcs

Add composer bin directory to your $PATH

In order to execute PHP Code sniffer from anywhere on Linux or Mac command line you have to add .composer/vendor/bin to your $PATH variable. To do this persistent edit your shells start file, like your .profile or .bash_profile file depending which shell you are using (echo $SHELL shows you which one you are using).

Add the following line to the file: export PATH=$PATH:~/.composer/vendor/bin

Alternatively you can also create a symbolic link in the bin folder: ln -s ~/.composer/vendor/bin/phpcs /usr/local/bin/phpcs

2. Install Joomla Coding Standards

In order to have PHP Code Sniffer (phpcs) sniffing your Joomla projects for the right code style, you have to install the Joomla Coding Standards.

Using composer we can execute: composer global require joomla/coding-standards '~3.0@alpha'

Notice that it says @alpha, that is because the coding standard is still in alpha state and we need to allow the installation of alpha status code. If we do not include the @alpha the coding standards will not install and throw this error.

Once the installation is done the coding standard will be installed in the global composer folder. The location of this folder depends on your operating system. Some popular locations are:

Mac / Linux

Windows

This is using Composer on Windows.

If you can't find it in any of the above folders, note that the folder you are looking for ends with joomlacoding-standards Finally we need to tell Code Sniffer that the Joomla coding standards exist.

Install Joomla Coding Standards

Check if certain paths are already set by running phpcs --config-show
You can get an answer that looks like this: installed_paths: /path/to/installation
In step 2, if you see the installed_paths you need to copy that
Set the Joomla Coding Standards path in phpcs by executing phpcs --config-set installed_paths /Users/user/.composer/vendor/joomla/coding-standards. If you copied any paths in step 2, include them here as well by separating them with a comma. The command looks like phpcs --config-set installed_paths [/to/path1],[/to/path2],[/Users/user/.composer/vendor/joomla/coding-standards]
Verify the path is set correctly by running phpcs --config-show
Verify that phpcs can see the Joomla codestyle by running phpcs -i
The output should look like this: The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend and Joomla

Phpstorm Codesniffer Drupal

Usage

Phpstorm Codesniffer Xml

You invoke the custom standard by phpcs --standard=Joomla file/to/sniff

To test a platform file using the provided platform coding standards, use phpcs --standard=build/phpcs/Joomla path/to/file/or/folder

Further documentation on the use of phpcs can be found at: [1]

3. IDE Integration

Everybody loves the console. It is, with no doubt, the most effective way to do whatever you need to do. Sometimes even Linux gurus need a little bit of comfort.

Fortunately there is a plug-in available for PhpStorm, Eclipse and Netbeans that integrates the CodeSniffer into your favourite IDE, so any coding standard violations are shown like 'normal' errors.

PhpStorm

Code Sniffer is supported out of the box in PhpStorm. Go to Settings and under Editor → Inspections you will see the list of sniffers you have installed.

Set Path to Code Sniffer

Open Settings (CTRL-ALT-S / CMD-,)
Go to Languages & Frameworks
Click on PHP
Click on Quality Tools
Click on PHP cs fixer dropdown arrow
The configuration is set to Local by default
Click on the 3 dots behind it to open the configuration screen
The first option is the PHP Code Sniffer (phpcs) path
Click on the 3 dots behind the path to select the location of the phpcs file. See above on where phpcs may be installed on your site
Click on Validate to make sure the path is correct and phpcs is working
Click OK

Activating the Joomla Code Style

Open Settings (CTRL-ALT-S / CMD-,)
Go to Editor
Click on Inspections
In the list, go to PHP
Click on PHP Code Sniffer Validation
Click on the check box behind it to activate it
Click the Reload button (2 arrows) to force a reload of rules from disk
Joomla should now be available in the list. See following image:
Click OK

PHP PSR-0, PSR-1 and PSR-2

Using PHP PSR-1 and PSR-2 Sniff

A CodeSniffer sniff to check against the PSR-x Coding Standard can be used as well. In that case you can select a different standard than Joomla.

Using Joomla Code style

It's nice to be able to check that the standards are respected. It's even nicer if PhpStorm helps you format properly too as you are coding. To use the Joomla code style in PhpStorm

Open Settings (CTRL-ALT-S / CMD-,)
Go to Editor
Click on Code Style
Select Joomla from the Scheme select box

PhpStorm / Alternative Method

NOTE: This method is outdated, but it might be useful if you are looking for a different integration. It also demonstrates the use of external tools in PhpStorm - so it shouldn't be deleted.

The Code Sniffer can also be integrated easily as an external tool. PhpStorm will display the output in the console, including click-able links containing line and column numbers to the files that contain errors.

Click on 'Settings' and search for 'External tools'
Click 'Add...'
Choose a 'Name', 'Group' and 'Description'.
Click 'Output Filters'
- Click 'Add...', Choose a name and enter under 'Regular expression to match output' the value: $FILE_PATH$:$LINE$:$COLUMN$
'Program': Search for the phpcs executable on your system. You have to set the path to the phpcs.bat from the installed PHP_CodeSniffer PEAR package
- For Unix based systems, the path is something like /usr/bin/phpcs
- In XAMPP (windows), you can find the file in the PHP root folder (e.g. C:xamppphpphpcs.bat)
'Parameters':
- --standard=<path/to/joomla-platform>/build/phpcs/Joomla The path to the Joomla! coding standards.
- --report=emacs The will generate a simple list containing links to the error files
- Optionally you may want to specify -p for 'progress' or -n for 'errors only'.
- The last parameter has to be $FilePath$ specifying the file or folder you want to sniff.

A typical 'Parameters' line on a Linux system might look like this:

You may now right click any file or folder and choose the sniffer from the context menu or add a new tool bar button with a nice Joomla! logo .