Настройка PHP CodeSniffer в PHPStorm (Linux)

Содержание:

• Настройка PHP Interpreter
• Установка PHP CodeSniffer
• Настройка инспекции в PhpStorm

Чтобы использовать PHP_CodeSniffer из PhpStorm вместо командной строки, необходимо зарегистрировать его в IDE и настроить как проверку кода в инспекциях. После установки и включения инструмент доступен в любом открытом файле PHP, никаких дополнительных шагов для его запуска не требуется. Проверка кода на лету активируется при каждом обновлении файла, что позволяет легко избавиться от обнаруженных проблем.

Настройка PHP Interpreter

Нужно настроить PHP интерпретатор для текущего проекта, если вы этого еще не сделали.

1. Откройте настройки: Settings/Preferences Ctrl+Alt+S и перейдите в раздел PHP.
2. На открывшейся странице нажмите кнопку обзора ... рядом со списком интерпретаторов CLI
3. Добавьте интерпретатор, нажав на иконку +

Путь к интерпретатору PHP обычно /usr/bin/php. Также можно использовать удаленный интерпретатор, например, через SSH, Docker, Vargant, etc.

Установка PHP CodeSniffer

Устанавливаем глобально в систему, через composer

composer global require "squizlabs/php_codesniffer"

Переменная PATH

Не забываем, что у вас в должен быть прописан PATH к vendor/bin/.

echo -e "\nexport PATH=\"\$PATH:~/.config/composer/vendor/bin\"\n" >> ~/.bashrc
source ~/.bashrc

Если вы всё сделали правильно, то при наборе в консоли phpcs -i должен появиться стандарт PSR-12 среди прочих.

phpcs -i
> The installed coding standards are PSR12, MySource, Zend, PSR2, Squiz, PEAR, and PSR1

Настройка инспекции в PhpStorm

Откройте настройки: Settings/Preferences Ctrl+Alt+S и перейдите в раздел PHP => Quality Tools (для быстрого доступа можно отфильтровать настройки по слову “sniffer”)

Выбираем Local и указываем полный путь к phpcs (например, /home/user/.config/composer/vendor/bin/phpcs).

Проверить корректность, можно нажав кнопку Validate

Далее переходим в раздел Editor => Inspections, ищем инспекцию PHP => PHP_CodeSniffer validation и включаем её, нажав на чекбокс.

В списке стандартов выбираем PSR12

Готово! Теперь при открытии файла phpcs будет проверять код на соответствие стандарту PSR-12.