{ "version": "https:\/\/jsonfeed.org\/version\/1", "title": "Максим Кузнецов: заметки с тегом codequality", "_rss_description": "Простыми словами о веб-разработке", "_rss_language": "ru", "_itunes_email": "", "_itunes_categories_xml": "", "_itunes_image": "", "_itunes_explicit": "", "home_page_url": "https:\/\/maxkuznetsov.ru\/tags\/codequality\/", "feed_url": "https:\/\/maxkuznetsov.ru\/tags\/codequality\/json\/", "icon": "https:\/\/maxkuznetsov.ru\/user\/userpic@2x.jpg?1586398004", "author": { "name": "Максим Кузнецов", "url": "https:\/\/maxkuznetsov.ru\/", "avatar": "https:\/\/maxkuznetsov.ru\/user\/userpic@2x.jpg?1586398004" }, "items": [ { "id": "39", "url": "https:\/\/maxkuznetsov.ru\/all\/code-quality-local\/", "title": "Как настроить php-cs-fixer и phpstan на локалке", "content_html": "

Проблема 1<\/h2>\n

При совместной разработке (от 2х человек) code style становится критичным. Если каждый будет писать в своём стиле, вскоре проект превратится в бардак, где по разному стилю можно будет оценивать возраст кода будто по кольцам на деревьях.<\/p>\n

На собеседованиях я часто слышу от кандидатов, что мы пользуемся проверками, встроенными в IDE. Но это полрешения, так как такие проверки носят рекомендательный, а не обязательный характер. Очень легко не заметить предложение по правке от IDE. А кроме того, приходится синхронизировать настройки IDE между всей командой. А что делать, если у кого-то другой редактор? Результат непредсказуем, а значит и ненадёжен.<\/p>\n

Проблема 2<\/h2>\n

Чем больше кодовая база проекта, тем проще допустить ошибку или опечатку. Вручную проверка кода перед каждым коммитом возможна, но требует много времени и большой внимательности. Результат опять непредсказуем и ненадёжен.<\/p>\n

Решение<\/h2>\n

Нужно договориться об общих правилах с командой и автоматизировать процесс проверки кода, сделав её независимой от IDE, платформы, настроения, желания и внимательности человека.<\/p>\n

Такие инструменты уже есть — code style и статические анализаторы кода.<\/p>\n

Единый стиль кода<\/h3>\n

Поскольку я специализируюсь на Symfony, то для код-стайла выбираю PHP-CS-Fixer<\/a>. Он написан при участии создателя Symfony и имеет из коробки поддержку рекомендованного сообществом Symfony Code Standards<\/a>. Есть ещё PHPCodeSniffer<\/a>, но он умеет только обнаруживать ошибки, но не исправляет их автоматически, поэтому я рекомендую именно PHP-CS-Fixer.<\/p>\n

Совет: обязательно изучите и следуйте code style и рекомендациям вашего фреймворка. С большой вероятностью в будущих проектах вам встретится именно общепринятый в сообществе фреймворка code style, поэтому будет проще вписаться в новую команду, если вы придёте к этому стилю как можно раньше. К тому же, уже принятый в сообществе стиль поможет избежать ненужных холиваров внутри команды.<\/p>\n

Устанавливаем через composer и настраиваем PHPCSFixer в Symfony-проекте:<\/p>\n

cd \/ваш\/проект\r\ncomposer req --dev friendsofphp\/php-cs-fixer\r\n# Если используете docker-compose, то устанавливайте в нём\r\ndocker-compose exec web composer req --dev friendsofphp\/php-cs-fixer<\/code><\/pre>
Создаём в корне проекта файл .php_cs<\/tt>:<\/p>\n
<?php\r\n\r\n$finder = PhpCsFixer\\Finder::create()\r\n    ->in([\r\n        __DIR__ . '\/src',\r\n        __DIR__ . '\/tests'\r\n    ])\r\n;\r\n\r\nreturn PhpCsFixer\\Config::create()\r\n    ->setRules([\r\n        '@Symfony' => true,\r\n        'array_syntax' => ['syntax' => 'short'],\r\n        'concat_space' => ['spacing' => 'one'],\r\n        'increment_style' => ['style' => 'post'],\r\n        'no_extra_blank_lines' => ['tokens' => [\r\n            'extra',\r\n            'parenthesis_brace_block',\r\n            'square_brace_block',\r\n            'throw',\r\n            'use',\r\n        ]],\r\n        'no_superfluous_phpdoc_tags' => false,\r\n        'phpdoc_align' => false,\r\n        'phpdoc_annotation_without_dot' => false,\r\n        'trailing_comma_in_multiline_array' => false,\r\n        'yoda_style' => false\r\n    ])\r\n    ->setFinder($finder)\r\n;<\/code><\/pre>
Теперь вы можете запустить проверку всего проекта (или конкретного пути) с помощью команды<\/p>\n
# только поиск ошибок\r\n.\/vendor\/bin\/php-cs-fixer  fix --dry-run --diff .\/\r\n# поиск ошибок и их автоматический фикс\r\n.\/vendor\/bin\/php-cs-fixer fix .\/<\/code><\/pre>
Ошибки и качество кода<\/h3>\n
Для отлова опечаток и даже поиска более сложных ошибок мы воспользуемся статическим анализатором кода. Прелесть анализаторов в том, что они не выполняют код, а просто читают и анализируют — это очень быстро. Кроме того, каждый из них имеет свои уровни строгости, поэтому можно внедрять их в существующий проект постепенно: фиксим ошибки с минимальным уровнем, коммитим, повышаем уровень, фиксим, коммитим, снова повышаем.<\/p>\n
Самые популярные статичиские анализаторы кода:<\/p>\n