Что такое PHP CS Fixer и как он может помочь вам сохранить чистоту вашего кода


Что такое PHP CS Fixer

PHP CS Fixer расшифровывается как PHP Coding Standards Fixer. Это инструмент, который исправляет ваш код в соответствии со стандартами. Существуют различные стандарты кодирования PHP, которым вы можете следовать, например, популярные PSR-1 и PSR-12, опубликованные PHP Framework Interoperability Group (полный список стандартов PSR можно найти здесь).

Существуют также другие стандарты, разработанные сообществом, например, Symphony.

С помощью PHP CS Fixer вы можете следовать нескольким стандартам кодирования одновременно, а также определить свой собственный стандарт кодирования или стандарт кодирования вашей команды с помощью конфигурации. Если вы когда-либо работали с JavaScript и Eslint в частности, считайте PHP CS Fixer альтернативой Eslint для PHP.

Ручное исправление стандартов кодирования в коде — очень утомительный процесс, поэтому PHP CS Fixer является отличным решением. Он поможет вам и вашей команде убедиться, что вы следуете одним и тем же правилам при написании кода, тем самым делая его чище.

Установка

Рекомендуемый способ установки PHP CS Fixer — использовать Composer в специальном каталоге в вашем проекте, например, в tools/php-cs-fixer.

mkdir --parents tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
Вход в полноэкранный режим Выход из полноэкранного режима

Более подробную информацию и другие способы установки смотрите в инструкции по установке.

Использование

Использование: Вариант 1

Если вы установили PHP CS Fixer, как указано выше, вы можете выполнить следующую команду для исправления файлов PHP в каталоге src:

tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
Войти в полноэкранный режим Выйти из полноэкранного режима

Более подробную информацию смотрите в документации по использованию, списку встроенных правил, списку наборов правил и файлу конфигурации. Если вам нужно применить стили кода, которые не поддерживаются инструментом, вы можете создать пользовательские правила.

Использование: Вариант 2 (интеграция с редактором)

Однако выполнение команды вручную не кажется удобным подходом. Лично я предпочитаю запускать PHP CS Fixer, нажав предварительно настроенное сочетание клавиш в PHP Storm.

Вы можете настроить PHP CS Fixer для различных редакторов кода, как описано ниже:

  • Atom
  • NetBeans
  • PhpStorm
  • Sublime Text
  • Vim
  • VS Code

Использование: Вариант 3 (Запуск PHP CS Fixer на каждом коммите)

В качестве альтернативного варианта вы можете исправлять код на каждом коммите, используя Husky и lint-staged. С помощью этих инструментов PHP CS Fixer будет запускаться на ваших staged файлах, другими словами, на файлах, которые вы хотите зафиксировать. Вот отличная статья, объясняющая, как настроить эти инструменты для работы с PHP CS Fixer.

Простой способ настройки PHP CS Fixer

Если вы новичок в стандартах кодирования PHP и хотите быстро настроить PHP CS Fixer, я настоятельно рекомендую использовать PHP CS Fixer Configurator от Michele Locati. В нем есть предустановленный набор правил, которые вы можете выбрать и создать свою собственную конфигурацию.

Большинство правил, при нажатии на них, отображают общую информацию о правиле, доступные опции конфигурации и примеры использования. Файл конфигурации PHP CS Fixer, созданный этим инструментом, может быть экспортирован для использования в вашем проекте, а затем импортирован снова, если вы захотите внести некоторые изменения.

Источник

  1. FriendsOfPHP/PHP-CS-Fixer: Инструмент для автоматического исправления проблем со стандартами кодирования PHP
  2. Конфигуратор PHP-CS-Fixer

Конец. Я надеюсь, что эта статья была вам полезна. Оставайтесь с нами и следите за новыми материалами!

Если вы хотите поддержать меня, вы можете купить мне кофе 🙂

Оцените статью
Procodings.ru
Добавить комментарий