Настройка PHP CodeSniffer в PhpStorm с помощью стандартов кодирования WordPress | Келлен Мейс

Шаги ниже показывают, как настроить PHP CodeSniffer в PhpStorm с наборами правил WordPress Coding Standards. Это может быть очень полезно для выявления нарушений стандартов кодирования WP при написании кода, поэтому вы можете исправить их на месте. В этом руководстве предполагается, что вы работаете в Mac OS X или Linux, используете Vagrant для локальной разработки, у вас надеюсь установлен Composer + вам удобно пользоваться командной строкой. Видео-пошаговое руководство по этим шагам также доступно здесь.

1. Настройте PHP Remote Interpreter

Перейдите в «Настройки

Preferences > Languages & Frameworks > PHP

, затем нажмите […]кнопку. Введите эти настройки:

• Переключатель SSH Credentials
• IP-адрес вашего хоста вместо показанного (вы можете получить его, запустив ping example.devодин из ваших сайтов  в командной строке)
• vagrant для имени пользователя и пароля
• /usr/bin/php для пути интерпретатора PHP

Затем выберите только что созданного переводчика:

2. Установите PHP CodeSniffer

composer global require "squizlabs/php_codesniffer=*"

Затем убедитесь, что phpcsпсевдоним доступен в ~/.composer/vendor/bin/каталоге.

3. Установите наборы стандартов WordPress

composer create-project wp-coding-standards/wpcs:dev-master --no-dev

Затем убедитесь, что стандарты WP доступны в ~/.composer/wpcs/каталоге.

4. Добавьте путь набора правил WordPress в конфигурацию PHP_CodeSniffer.

cd ~/.composer/vendor/bin phpcs --config-set installed_paths ~/.composer/wpcs

5. Добавьте phpcs в ваш путь

Открыть ~/.bash_profile(или ~/.zshrcесли вы используете ZSH). Вставить в: PATH=$PATH:~/.composer/vendor/bin. Теперь вы сможете cdвойти в любой корневой каталог WP и запустить его phpcs --standard=WordPress wp-load.php. Если вы увидите такой вывод, вы поймете, что phpcs работает правильно:

6. Настройте PHP CodeSniffer

В PhpStorm, перейдите к Preferences> Languages & Frameworks> PHP> Code Sniffer.

Выберите этот файл: ~/.composer/vendor/bin/phpcs.

7. Настройте PHP CodeSniffer как проверку PhpStorm

В PhpStorm, перейдите Preferences> Editor> Inspections. Перейдите к PHP> PHP Code Sniffer Validationи установите флажок. Выберите стандарт кодирования WordPress из выпадающего меню и сохраните его.

Попробуйте это

Теперь попробуйте ввести что-то, что является допустимым PHP, но является нарушением стандартов кодирования WordPress, например:

if(true){echo 'I must have forgotten a few spaces';}

PhpStorm должен дать вам знать, что это нарушение, подчеркнув это волнистым подчеркиванием. Вы можете навести на него курсор и получить всплывающее окно с дополнительной информацией, указывающей, что с ним не так. После этого вы можете установить его вручную, или использовать Code> Reformat Code(Cmd + Option + L на Mac), чтобы автоматически переформатировать код – просто убедитесь, что вы установили предопределенный стиль для WordPress в PhpStorm – х Preferences> Editor> Code Style> PHP> Set From> Predefined Style> WordPress.

Идти вперед

Чтобы включить PHP CodeSniffer со стандартами кодирования WP для любых будущих проектов, вам просто нужно выполнить шаги 1 и 7 выше.

Ресурсы

JetBrains PHP CodeSniffer Guide:
https://www.jetbrains.com/help/phpstorm/using-php-code-sniffer.html

PHP CodeSniffer:
https://github.com/squizlabs/PHP_CodeSniffer

Наборы правил кодирования WordPress:
https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards

Руководство Джейсона Бойла – содержит дополнительные сведения о нескольких шагах в этом посте:
http://jason-boyle.com/phpstorm-php-codesniffer-wordpress-coding-standards/