Инструмент PHP Coding Standards Fixer (PHP CS Fixer) исправляет ваш код в соответствии со стандартами; хотите ли вы следовать стандартам кодирования PHP, определенным в PSR-1, PSR-2 и т. д., или другим стандартам, разработанным сообществом, например, Symfony. Вы также можете определить стиль своей (команды) посредством конфигурации.
Он может модернизировать ваш код (например, преобразовать функцию pow
в оператор **
в PHP 5.6) и (микро) оптимизировать его.
Если вы уже используете линтер для выявления проблем со стандартами кодирования в своем коде, вы знаете, что исправлять их вручную утомительно, особенно в больших проектах. Этот инструмент не только обнаруживает их, но и исправляет за вас.
Примечание. Каждая новая версия PHP требует огромных усилий для поддержки нового синтаксиса. Вот почему последняя версия PHP может еще не поддерживаться. Если вам это необходимо, рассмотрите возможность поддержки проекта любым удобным способом, например, добавив код или просмотрев существующие PR. Чтобы запустить PHP CS Fixer на еще неподдерживаемых версиях «на свой страх и риск» — используйте PHP_CS_FIXER_IGNORE_ENV.
Рекомендуемый способ установки PHP CS Fixer — использовать Composer в специальном файле composer.json
вашего проекта, например в каталоге tools/php-cs-fixer
:
mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
Или используя основной composer.json
:
composer require --dev friendsofphp/php-cs-fixer
Более подробную информацию и другие способы установки см. в инструкциях по установке.
Вы можете использовать готовые образы Docker для запуска php-cs-fixer
.
docker run -it --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src
$FIXER_VERSION
используемый в приведенном выше примере, представляет собой идентификатор выпуска, который вы хотите использовать, который основан на сочетании версий Fixer и PHP. Существуют разные теги для каждого уровня SemVer и версии PHP Fixer с синтаксисом <php-cs-fixer-version>-php<php-version>
. Например:
3.57.0-php7.4
3.57-php8.0
3-php8.3
Предполагая, что вы установили PHP CS Fixer, как указано выше, вы можете запустить следующую команду, чтобы исправить файлы PHP в каталоге src
:
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
Для получения более подробной информации см. использование, список встроенных правил, список наборов правил и документацию по файлу конфигурации.
Если вам нужно применить стили кода, которые не поддерживаются инструментом, вы можете создать собственные правила.
Существуют специальные плагины для:
PHP CS Fixer поддерживается на GitHub по адресу https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Сообщения об ошибках и идеи о новых функциях приветствуются.
Вы можете связаться с нами в разделе «Обсуждения» проекта, конфигурации, возможных улучшений, идей и вопросов на GitHub. Пожалуйста, посетите нас там!
Инструмент поставляется с довольно большим количеством встроенных исправлений, но каждый может добавить их больше.