PHP_CodeSniffer
3.7.2
Предупреждение
Этот репозиторий был заброшен. Его преемником являются phpcsstandards/php_codesniffer
См. Выпуск № 3932 для получения дополнительной информации.
Php_codesniffer - это набор из двух сценариев PHP; Основной скрипт phpcs , который токенизирует файлы PHP, JavaScript и CSS для обнаружения нарушений определенного стандарта кодирования, и второй скрипт phpcbf для автоматического исправления стандартных нарушений кодирования. PHP_CODESNIFFER - это важный инструмент разработки, который гарантирует, что ваш код остается чистым и последовательным.
PHP_CODESNIFFER требует PHP версии 5.4.0 или выше, хотя отдельные нюхания могут иметь дополнительные требования, такие как внешние приложения и сценарии. Смотрите страницу «Руководство по параметрам конфигурации» для списка этих требований.
Если вы используете php_codesniffer как часть команды, или вы запускаете его на сервере CI, вы можете настроить настройки вашего проекта с помощью файла конфигурации.
Самый простой способ начать работу с php_codesniffer - загрузить файлы Phar для каждой из команд:
# Download using curl curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar # Or download using wget wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar # Then test the downloaded PHARs php phpcs.phar -h php phpcbf.phar -h
Если вы используете композитор, вы можете установить PHP_Codesniffer System System со следующей командой:
Composer Global требует "squizlabs/php_codesniffer =*"
Убедитесь, что на вашем пути есть Dir Composer Bin Dir. Значение по умолчанию- ~/.composer/vendor/bin/ , но вы можете проверить значение, которое необходимо использовать, используя composer global config bin-dir --absolute .
Или альтернативно, включите зависимость для squizlabs/php_codesniffer в вашем файле composer.json . Например:
{"require-dev": {"squizlabs/php_codesniffer": "3.*"}
}Затем вы сможете запустить php_codesniffer из каталога поставщика Bin:
./vendor/bin/phpcs -h ./vendor/bin/phpcbf -h
Если вы используете Phive, вы можете установить php_codesniffer в качестве инструмента проекта, используя следующие команды:
Phive установить PHPCS Phive установить phpcbf
Затем вы сможете запустить php_codesniffer из каталога инструментов:
./tools/phpcs -h ./tools/phpcbf -h
Если вы используете грушу, вы можете установить php_codesniffer с помощью установщика Pear. Это сделает команды phpcs и phpcbf немедленно доступными для использования. Чтобы установить php_codesniffer с помощью установщика Pear, сначала убедитесь, что вы установили Pear, а затем запустите следующую команду:
Груша Установка php_codesniffer
Вы также можете загрузить источник php_codesniffer и запустить команды phpcs и phpcbf непосредственно из клона GIT:
git clone https://github.com/squizlabs/php_codesniffer.gitcd php_codesniffer Php bin/phpcs -h Php bin/phpcbf -h
Стандарт кодирования по умолчанию, используемый PHP_Codesniffer, является стандартом кодирования груши. Чтобы проверить файл по стандарту кодирования груши, просто укажите местоположение файла:
phpcs /path/to/code/myfile.php
Или, если вы хотите проверить весь каталог, вы можете указать местоположение каталога вместо файла.
PHPCS/PATH/TO/CODE-DIRECTORY
Если вы хотите проверить свой код по стандарту кодирования PSR-12, используйте аргумент командной строки --standard :
phpcs-Standard = psr12/path/to/code-directory
Если php_codesniffer находит какие -либо стандартные ошибки кодирования, после запуска команды будет показан отчет.
Информация о полном использовании и примеры отчетов доступны на странице использования.
Документация для php_codesniffer доступна на вики Github.
Отчеты об ошибках и запросы функций могут быть представлены на трекере выпуска GitHub.
См. Appling.md для получения информации.
Php_codesniffer использует формат номера версии MAJOR.MINOR.PATCH .
MAJOR версия увеличивается, когда:
Вносимых изменений в обратном направлении, как используются команды phpcs или phpcbf , или
обратно-несовместимые изменения вносятся в формат ruleset.xml , или
За обратные несоблюдения внесены изменения в API, используемый разработчиками Sniff, или
Пользовательские типы токенов PHP_CODESNIFFER удалены, или
Существующие нюхания полностью удаляются из php_codesniffer.
MINOR версия увеличивается, когда:
Новые обратно-совместимые функции добавляются в команды phpcs и phpcbf , или
За обратные совместимые изменения вносятся в формат ruleset.xml , или
За обратные совместимые изменения вносятся в API, используемый разработчиками Sniff, или
Новые нюхания добавляются в включенный стандарт, или
Существующие нюхания удаляются из включенного стандарта
ПРИМЕЧАНИЕ. За обратные совместимые изменения в API, используемом разработчиками Sniff, позволят существующему нюханию продолжать работать без роста, но не может привести к тому, что Sniff сообщают о тех же ошибках, что и ранее, без изменений.
PATCH -версия увеличивается, когда:
Случайно совместимые исправления ошибок
ПРИМЕЧАНИЕ. Поскольку существует PHP_CODESNIFFER, чтобы сообщать и исправлять проблемы, большинство ошибок являются результатом того, что стандартные ошибки кодирования неверно сообщают или не сообщаются стандартные ошибки, когда они должны быть. Это означает, что сообщения, произведенные PHP_Codesniffer, и исправления, которые он делает, могут быть различными между версиями патчей.
