php sniffer как установить
Основы PHP_CodeSniffer
В некоторых компаниях есть большая база долгоиграющих и постоянно изменяющихся проектов. Без неусыпного контроля база кода рискует превратиться в месиво из малочитаемых файлов. Вручную проверять код на соответствие стандартам занятие достаточно утомительное. Быстро появляется потребность в атоматизации процесса.
Установка и запуск
В самом простом случае можно выполнить такой код в папке с исходниками проекта:
Так же поддерживается установка через composer. Далее будет рассматриваться именно этот вариант.
Пропишем в composer.json следующий код:
После обновления composer пробуем выполнить
Чтобы посмотреть перечень доступных стандартов, можно выполнить
Для вывода списка проверок интересующего стандарта (в данном случае PSR-2) выполняем:
Проверка кода
К примеру, при кодировании мы хотим следовать стандарту PSR-2.
Выполняем в консоли:
Данная команда проверит все файлы проекта на соответствие PSR-2. Все файлы нам не нужны, поэтому некоторые мы можем смело исключить:
В примере выше я исключил папки с тестами проекта, а так же третьесторонние модули и файлы js-скриптов и стилей css (PHP_CodeSniffer знает некоторые проверки для css и js-файлов тоже).
Если до первого запуска скрипта код никаким стандартам не соответствовал, то в логе нас ждет большая куча сообщений.
Быстро исправить некоторые простые вещи поможет выполнение следующего кода:
Затем можно снова вызвать phpcs и доправить остальные замечания вручную.
Что дальше?
В идеале PHP_CodeSniffer должен запускаться с определенной периодичностью. Желательно перед сдачей кода в master-ветку проекта. Оставим этот вопрос за пределами данной заметки.
Если в вашей компании есть свой ни на что не похожий code-style, то здесь вам поможет написание собственного набора правил в формате xml.
В данном файле можно описать какие проверки следует выполнять, с какими параметрами запускать скрипты PHP_CodeSniffer и прочее.
После написания собственного набора правил, подключить его можно просто:
Желаю успеха в борьбе с беспорядком в коде!
Php sniffer как установить
Автоформатирование кода: PHP CodeSniffer и PHP CS Fixer
На laracasts есть замечательное видео по этой теме в контексте PhpStorm, здесь же пойдёт речь о том, чего не рассказывал в том видео Джефри (ну а если хотите настроить фиксер под Sublime, смотрите эту статью).
PHP CodeSniffer
Давайте начнём с PHP CodeSniffer. Этот инструмент поможет выявить нарушения форматирования, при надлежащей настройке PhpStorm будет вас об этом информировать путём выделения проблемных частей кода. Кроме всего прочего мы можем воспользоваться консолью для вывода информации об ошибках.
Установка
Используемый стандарт
Также хорошенько подумайте о том, достаточно ли набора правил стандарта. Вполне возможно, что ответ будет отрицательным. Перечитайте документацию, и добавьте те, которые Вам понадобятся.
Можно каждый раз в консоли руками пописывать какие-то дополнительные правила или условия, указывать стандарт и т.д. Но, мы же понимаем, что это не оптимальный вариант. Поэтому, в корне проекта создадим файл phpcs.xml и добавим туда следующее (в качестве примера использую код из текущего проекта):
Пояснения:
Основные команды
Вывести список установленных стандартов:
Вывести список снифов, используемых в конкретном стандарте:
Проверить форматирование файла file.php :
Проверить весь проект :
Проверить весь проект с выводом информации о том, где конткретно были встречены ошибки:
Вывести код-репорт, т.е. отчёт со сниппетами кода, где были обнаружены ошибки:
Есть ещё и другие команды, но, по моему мнению, вполне хватает перечисленных. Справедливости ради стоит отметить, что PHP CoedSniffer также включает и code beautifier fixer, т.е. можно исправить ошибки (читай отформатировать) командой:
но я всё же предпочитаю php-cs-fixer
PHP CS Fixer
Установка
Опять-таки подумайте устанвливать интсрумент глобально, или для каждого проекта. Второй вариант:
Если выбираете глобальную установку, убедитесь, что в переменную PATH добавлен путь к бинарным файлам composer-a. Проверьте это командой:
Пользовательские правила
Автоформат
Основные команды
Вывести список команд:
Вывести описание правил входящих в конкретный стандарт:
И, как уже был сказано, отформатировать (для разнообразия укажем стандарт Symfony):
В случае с fixer-ом я предпочитаю использовать не консоль, а настроить PhpStorm для использования этого инструмента, добавить горячие клавиши и использовать по месту в конкретных файлах.
Git pre-commit hook
Подведём итоги. Мы используем:
Внимание: php-cs-fixer исправит только те ошибки, которые он может исправить, не более. Например, если у Вас не написан phpdoc, fixer за вас его не напишет. Помните об этом.
Настройка 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
, затем нажмите […] кнопку. Введите эти настройки:
Затем выберите только что созданного переводчика:
2. Установите PHP CodeSniffer
composer global require «squizlabs/php_codesniffer=*»
Затем убедитесь, что phpcs псевдоним доступен в
3. Установите наборы стандартов WordPress
Затем убедитесь, что стандарты WP доступны в
4. Добавьте путь набора правил WordPress в конфигурацию PHP_CodeSniffer.
5. Добавьте phpcs в ваш путь
/.zshrc если вы используете ZSH). Вставить в: PATH=$PATH:
6. Настройте PHP CodeSniffer
Выберите этот файл:
7. Настройте PHP CodeSniffer как проверку PhpStorm
Попробуйте это
Теперь попробуйте ввести что-то, что является допустимым PHP, но является нарушением стандартов кодирования WordPress, например:
Идти вперед
Чтобы включить PHP CodeSniffer со стандартами кодирования WP для любых будущих проектов, вам просто нужно выполнить шаги 1 и 7 выше.
linux-notes.org
PHP_CodeSniffer — Представляет собой набор из двух PHP-скриптов; Основной скрипт phpcs, который выделяет PHP, JavaScript и CSS-файлы для обнаружения нарушений определенного стандарта кодирования, а второй скрипт phpcbf автоматически исправляет стандартные нарушения кодирования. PHP_CodeSniffer — это важный инструмент разработки, который гарантирует, что ваш код остается чистым и последовательным.
Установка PHP_CodeSniffer в Unix/Linux
-=== Использование готового пакета===-
Самый простой способ начать работу с PHP_CodeSniffer — загрузить файлы Phar для каждой из команд:
И еще одно действие:
Для удобства, я бы переместил данные файлы:
-=== Использование установщика PEAR===-
Если вы используете PEAR, вы можете установить PHP_CodeSniffer с помощью PEAR-установщика. Чтобы установить PHP_CodeSniffer с помощью PEAR-установщика (сначала убедитесь, что вы установили PEAR) выполните следующую команду:
-=== Использование Composer===-
Если вы предпочитаете использовать Composer, вы можете легко установить PHP_CodeSniffer для всей системы с помощью следующей команды:
PS: если нужно установить composer — вот статья:
Убедитесь, что у вас есть каталог bin в PATH. Значение по умолчанию:
/.composer/vendor/bin/, но вы можете проверить данное значение, запустив команду:
Или, альтернативно, включите зависимость для squizlabs/php_codesniffer в вашем composer.json файле. Для примера:
После этого вы сможете запускать PHP_CodeSniffer из папки установщика:
Вы также можете скачать PHP_CodeSniffer с исходного кода и запускать phpcs и phpcbf команды из под директории. Например:
Как-то так. У меня с темой «Установка PHP_CodeSniffer в Unix/Linux» все.
Php sniffer как установить
PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
PHP_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the Configuration Options manual page for a list of these requirements.
If you’re using PHP_CodeSniffer as part of a team, or you’re running it on a CI server, you may want to configure your project’s settings using a configuration file.
The easiest way to get started with PHP_CodeSniffer is to download the Phar files for each of the commands:
If you use Composer, you can install PHP_CodeSniffer system-wide with the following command:
Make sure you have the composer bin dir in your PATH. The default value is
Or alternatively, include a dependency for squizlabs/php_codesniffer in your composer.json file. For example:
You will then be able to run PHP_CodeSniffer from the vendor bin directory:
If you use Phive, you can install PHP_CodeSniffer as a project tool using the following commands:
You will then be able to run PHP_CodeSniffer from the tools directory:
If you use PEAR, you can install PHP_CodeSniffer using the PEAR installer. This will make the phpcs and phpcbf commands immediately available for use. To install PHP_CodeSniffer using the PEAR installer, first ensure you have installed PEAR and then run the following command:
You can also download the PHP_CodeSniffer source and run the phpcs and phpcbf commands directly from the Git clone:
The default coding standard used by PHP_CodeSniffer is the PEAR coding standard. To check a file against the PEAR coding standard, simply specify the file’s location:
Or if you wish to check an entire directory you can specify the directory location instead of a file.
If PHP_CodeSniffer finds any coding standard errors, a report will be shown after running the command.
Full usage information and example reports are available on the usage page.
The documentation for PHP_CodeSniffer is available on the Github wiki.
Bug reports and feature requests can be submitted on the Github Issue Tracker.
See CONTRIBUTING.md for information.
PHP_CodeSniffer uses a MAJOR.MINOR.PATCH version number format.
The MAJOR version is incremented when:
The MINOR version is incremented when:
NOTE: Backwards-compatible changes to the API used by sniff developers will allow an existing sniff to continue running without producing fatal errors but may not result in the sniff reporting the same errors as it did previously without changes being required.
The PATCH version is incremented when:
NOTE: As PHP_CodeSniffer exists to report and fix issues, most bugs are the result of coding standard errors being incorrectly reported or coding standard errors not being reported when they should be. This means that the messages produced by PHP_CodeSniffer, and the fixes it makes, are likely to be different between PATCH versions.
About
PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.