Несколько дней новогоднего волшебства:
Успейте начать обучение в 2018-ом году со скидкой до 30%!
Выбрать курс

Используем CodeSniffer

PHP_Deep_LAST_10.07_3_site.png

Сейчас большинство команд разработки принимает на вооружение стандарты кодирования и организовывает процедуры следования им. Самый лучший способ следить за соблюдением принятых стандартов, конечно же, это code review. Но постоянное возвращение кода из-за незамеченного тобой отступления от правил кодирования, к примеру, отсутствия отступа перед оператором return, не добавляет популярности данной процедуре. Чтобы уменьшить объём подобных небрежностей, для PHP-программистов существует инструмент CodeSniffer.

Чтобы не пропустить очевидных нарушений стандарта кодирования, можно добавить запуск CodeSniffer’а хуком после каждого коммита. Для тех, кто использует PHPStorm, есть возможность использовать готовый плагин, который будет автоматически запускать проверку кода и выполнять подсветку мест, которые не прошли проверку, сразу в редакторе.

Сам по себе PHPCS уже из коробки содержит множество существующих стандартов – PSR1, PSR2, PEAR, Zend. При этом самым интересным в использовании CodeSniffer является возможность его расширения под собственные внутренние правила. Поэтому на GitHub легко можно найти множество готовых расширений, позволяющих использовать кастомные правила, например, реализация стандартов, принятая разработчиками на Symfony2.

Одна из самых распространенных причин, по которой разработчики отказываются использовать CodeSniffer в повседневной работе, – наличие собственных правил, реализация которых отсутствует в сборке. Но очень хорошей практикой для вас как для разработчиков является возможность самим реализовать эти правила, которые приняты только внутри вашей команды, чтобы в будущем вся команда пользовалась ими. Разработчики подготовили очень качественный мануал, по которому вы сможете начать разрабатывать «сниффы», то есть правила, проверяющие следование определённому правилу принятого стандарта.

Например, в нашей компании для пресечения непрекращающегося холивара на тему использования Yoda conditions принято правило, которое запрещает такие конструкции. Здесь можно посмотреть готовое расширение, которое позволяет сканировать ваш код на наличие таких условий: AvoidYodaConditionsSniff.php.

Есть вопрос? Напишите в комментариях!

Автор
0 комментариев
Для комментирования необходимо авторизоваться