PHP Code Sniffer для Kohana 3

Как вы знаете, для того что бы написать хороший поддерживаемый код, нужно не только хорошо знать синтаксис языка программирования, но и писать код, удовлетворяющий общепринятым требованиям к оформлению кода.

Понятно, что после строительства Вавилонской башни, общепринятых требований только увеличилось. В том числе и для Kohana появились специальные соглашения.

Что бы регулярно следить за качеством своего кода, была создана удобная консольная утилита phpcs.

Суть её крайне проста. После написания нового или отредактированного кода, мы запускаем утилиту и проверяем наши файлы с исходниками на соответствие с требованиями к оформлению кода. Если есть ошибки, утилита показывает где они были совершены и что было сделано не правильно.

Давайте опробуем её на файле из предыдущей статьи.

`

phpcs –standard=Kohana application/classes/field/image.php

FILE: application/classes/field/image.php

FOUND 7 ERROR(S) AND 0 WARNING(S) AFFECTING 6 LINE(S)

93 | ERROR | No space is allowed around concatenation operators 96 | ERROR | Operators && and || are not allowed, use AND and OR instead 109 | ERROR | All comparisons and operations in ternary conditions must be | | done inside of a parentheses group 109 | ERROR | All comparisons and operations in ternary false values must be | | done inside of a parentheses group 156 | ERROR | A single space is required on either side of ! and & operators 176 | ERROR | No space is allowed around concatenation operators

177 | ERROR | Operators && and || are not allowed, use AND and OR instead

`

Думаю тут всё понятно, но я всё же поясню.
Первая колонка — это номер строки в которой было обнаружено неправильное оформлении кода.
Вторая колонка — это тип ошибки. Они стандартны: ERROR, WARNING, NOTICE
Третья колонка — иногда она может быть на двух строках — это сообщение с детальным объяснением ошибки.

Ей можно скормить как обычный файл, так и каталог с исходниками, так и каталог с подкаталогами с исходниками и прочее, прочее.. Подробнее о примерах использования можно прочитать на её официальном сайте.

Если утилита вас заинтересовала, то давайте её попробуем поставить и настроить.

Установка происходит точно так же, как и устанавливаются все программы PEAR. Я предполагаю что вы работайте на системе Linux.

Ставим PEAR

sudo apt-get install pear

Обновляем список доступных каналов

sudo pear update-channels

Обновляем все установленные каналы

sudo pear upgrade-all

Устанавливаем PHP Code Sniffer

sudo pear install PHP_CodeSniffer

Если всё прошло гладко, то у нас установлена утилита phpcs. Её уже можно использовать. Но для того, что бы добавить к ней проверку по стандартам программирования Kohana, нужно совершить ещё пару действий.

Скачиваем репозитарий со стандартами оформления кода для Kohana

git clone http://github.com/elazar/phpcs-kohana.git phpcs-kohana

И добавляем скачанные файлы в каталог к системным стандартам

sudo cp -R ./phpcs-kohana/PHP /usr/share/php/

Теперь, запуская phpcs мы можем указывать стандарт оформления Kohana

phpcs --standard=Kohana

Что бы нам не указывать стандарт Kohana каждый раз, мы можем указать его в системных настройках

sudo phpcs --config-set default_standard Kohana

Ну вот и всё.. Теперь можно проверять свои файлы простейшей командой

phpcs /www/kohana

Read more posts by this author.