В этой статье мы научимся подключать утилиту PHP Code Sniffer к нашему проекту.
Допустим у нас уже есть проект на базе PHP фреймворка Laravel, который использует стандарт PSR-2 и нам необходимо добавить Code Sniffer в данный проект.
Для начала, нам необходимо установить сам "php_codesniffer".
Сделать это можно с помощью менеджера зависимостей Composer:
composer require --dev squizlabs/php_codesniffer
Далее мы можем добавить алиасы, для удобного запуска утилиты.
Добавим их в composer.json:
"scripts": {
"cs-check": "phpcs",
"cs-fix": "phpcbf"
}
Далее необходимо создать файл "phpcs.xml" в корневой директории проекта и поместить туда следующее содержание:
<?xml version="1.0"?>
<ruleset name="PSR2">
<description>The PSR2 coding standard.</description>
<rule ref="PSR2"/>
<file>app/</file>
<exclude-pattern>bootstrap/cache</exclude-pattern>
<exclude-pattern>node_modules</exclude-pattern>
<exclude-pattern>public</exclude-pattern>
<exclude-pattern>resources</exclude-pattern>
<exclude-pattern>storage/</exclude-pattern>
<exclude-pattern>vendor</exclude-pattern>
</ruleset>
В этом файле нужно указать какие папки стоит проверять, а какие можно пропустить.
Теперь в корневой директории проекта, мы можем запускать проверку:
composer cs-check
Если PHP Code Sniffer найдёт ошибки, их можно будет исправить командой:
composer cs-fix
Получай анонсы новых статей на свой E-Mail!
Если у Вас остались какие-либо вопросы, либо у Вас есть желание высказаться по поводу этой статьи, то Вы можете оставить свой комментарий: