PHP Codesniffer

В первой статье мы рассмотрели что такое code smell и разобрали несколько примеров того, как можно улучшить код.

В конеченом счете, мы работаем над улучшением кода под WordPress, но прежде надо ознакомиться с PHP CodeSniffer.

В этой статье мы рассмотрим, что такое PHP CodeSniffer, как его установить, как запустить с его помощью пример скрипта и как рефакторить указанный скрипт. Будем двигаться вперед в коде, специфичном для WordPress

Если у Вас настроена среда разработки, то отлично; если нет, то я приведу некоторые ссылки, которые помогут быстро начать работу.

Необходимые компоненты

Если Вы читаете это, то полагаю, что у Вас есть как минимум WordPress установленный ка локальном сервере. Если это не так, то вы легко найдете всю информацию в интернете. Я рекомендую устанавливать Open Server, а WordPress можно скачать с официального сайта.

Поддерживается версия PHP не ниже 5.4.0

Также путь к php.exe должен быть указан в системных переменных среды. Для Windows это можно сделать так: Мой компьютер -> Свойства -> Дополнительные параметры системы -> Переменные среды

Обычно этот файл находится в папке с локальным сервером. Если в настройках уже указан какой-то путь, то разделите пути точкой с запятой.

Как проверить все ли работает? Наберите в консоли $ php -v. Вы должны увидеть нечто подобное:

PHP 5.6.10 (cli) (built: Jul  6 2015 14:28:54) 
Copyright (c) 1997-2015 The PHP Group
Zend Engine v2.6.0, Copyright (c) 1998-2015 Zend Technologies

Что такое PHP CodeSniffer?

Для начала приведу ссылку на проект PHP CodeSniffer на GitHub

PHP CodeSniffer состоит из двух скриптов; главный phpcs размечает PHP, JavaScript, CSS файлы для определения нарушений определенных стандартов кода. Второй скрипт phpcbf автоматически исправляет ошибки в коде. PHP_CodeSniffer это полезный инструмет разработчика, гарантирующий чистоту и последовательности кода.

Установка

git clone https://github.com/squizlabs/PHP_CodeSniffer.git
cd PHP_CodeSniffer
php bin/phpcs -h
php bin/phpcbf -h