PHP-CS-Fixer - это инструмент для автоматической коррекции стиля кода в PHP. Он позволяет автоматически приводить код к соответствию стандартам кодирования, что помогает улучшить читаемость и поддерживаемость вашего кода. В этой статье мы рассмотрим, как настроить PHPCS Fixer в PHPStorm.
Шаг 1: Установка PHPCS Fixer
Прежде чем начать настройку, убедитесь, что у вас установлен PHPCS Fixer. Вы можете установить его глобально в систему с помощью Composer, выполнив следующую команду:
composer global require friendsofphp/php-cs-fixer
Либо можно установить PHPCS Fixer в текущем проекте:
composer require --dev friendsofphp/php-cs-fixer
Шаг 2: Настройка PHPCS Fixer
- Откройте PHPStorm и перейдите в настройки (Settings)
- В разделе
PHP
->Quality Tools
выберитеPHP CS Fixer
в качестве инструмента внешнего форматирования - Далее перейдите в подраздел
PHP CS Fixer
- Выберите текущий php-интерпретатор в поле
Configuration
и активируйте чекбокс - В поле
Rules
установите стандарт, например,PSR12
- Нажмите “Apply”, чтобы сохранить настройки
Шаг 3: Настройка Code Style
- В настройках PHPStorm перейдите в раздел
Editor
->Inspections
- Найдите в списке инспекций
PHP
->Quality Tools
->PHP CS Fixer validation
и включите инспекцию - Нажмите “OK”, чтобы сохранить и закрыть окно настроек
Шаг 4: Использование PHPCS Fixer
Теперь, когда PHPCS Fixer настроен в PHPStorm, вы можете использовать его для автоматической коррекции стиля кода.
- Откройте файл с PHP кодом в PHPStorm
- Выберите в меню пункт
Code
, а затемReformat code
или используйте сочетание клавиш Ctrl + Alt + L (на Windows/Linux) или Cmd + Option + L (на macOS) - PHPCS Fixer автоматически приведет ваш код к соответствию стандартам кодирования
Шаг 5: Настройка дополнительных правил
Вы также можете настроить дополнительные правила для PHPCS Fixer в файле .php-cs-fixer.php
, в корневом каталоге вашего проекта. В этом файле вы можете указать конкретные правила, которые должны быть применены при исправлении кода.
Пример файла .php-cs-fixer.php
:
<?php
$finder = (new PhpCsFixer\Finder())
->ignoreDotFiles(false)
->ignoreVCSIgnored(true)
->exclude(['dev-tools/phpstan', 'tests/Fixtures'])
->in(__DIR__);
return (new PhpCsFixer\Config())
->setRiskyAllowed(true)
->setRules([
'@PHP74Migration' => true,
'@PHP74Migration:risky' => true,
'@PHPUnit100Migration:risky' => true,
'@PhpCsFixer' => true,
'@PhpCsFixer:risky' => true,
'modernize_strpos' => true,
])
->setFinder($finder)
;
Заключение
Настройка PHPCS Fixer в PHPStorm позволяет автоматически приводить ваш код к соответствию стандартам кодирования. Это помогает улучшить читаемость и поддерживаемость вашего кода. Следуя этим шагам, вы сможете настроить PHPCS Fixer в PHPStorm и использовать его для автоматической коррекции стиля кода.