Як відформатувати код в PhpStorm використовуючи PHP CS Fixer

Як відформатувати код в PhpStorm використовуючи PHP CS Fixer

Починаючи з версії 5.8 Laravel включає файл .styleci.yml, який містить інструкції для форматування коду відповідно до правил пресету Laravel. Проблема в тому, що таке форматування можливо при пуші змін, але не локальній машині. Я вже розповідав, як використовувати CodeSniffer, але, на жаль, цей інструмент не включає всіх потрібних правил. Звернемося до PHP CS Fixer.

 

Даний матеріал є результатом перегляду кожного правила вищезгаданого пресету, і використання в конфігурації відповідностей PHP CS Fixer. Крім того, я додав деякі правила з Symfony. Наприклад, мені не хочеться бачити марну директиву use, а також непотрібні else і return. Та й docblock-и читаються краще, коли вони згруповані. Поїхали.

1. Встановлюємо PHP CS Fixer глобально:

$ composer global require friendsofphp/php-cs-fixer

 

Убедитесь, що в Вашій змінній PATH вказана директорія бінарних файлів Composer-а. Розміщення каталогу залежить від платформи. Приклад для деяких систем Unix:

$ export PATH="$PATH:$HOME/.composer/vendor/bin"

 

2. У корені проекту створюємо файл .php_cs.dist та копіюємо в нього наступний код:

<?php

$finder = PhpCsFixer\Finder::create()
    ->exclude(['bootstrap', 'node_modules', 'public', 'storage', 'vendor'])
    ->notPath('*')
    ->in(__DIR__);

return PhpCsFixer\Config::create()
    ->setRiskyAllowed(true)
    ->setRules([
        '@PSR2' => true,
        'array_syntax' => ['syntax' => 'short'],
        'binary_operator_spaces' => true,
        'blank_line_after_namespace' => true,
        'blank_line_after_opening_tag' => true,
        'blank_line_before_return' => true,
        'braces' => true,
        'cast_spaces' => true,
        'class_attributes_separation' => true,
        'class_definition' => true,
        'concat_space' => ['spacing' => 'none'],
        'declare_equal_normalize' => ['space' => 'none'],
        'elseif' => true,
        'encoding' => true,
        'full_opening_tag' => true,
        'function_declaration' => ['closure_function_spacing' => 'one'],
        'function_typehint_space' => true,
        'heredoc_to_nowdoc' => true,
        'include' => true,
        'increment_style' => ['style' => 'post'],
        'linebreak_after_opening_tag' => true,
        'list_syntax' => ['syntax' => 'short'],
        'lowercase_cast' => true,
        'lowercase_constants' => true,
        'lowercase_keywords' => true,
        'lowercase_static_reference' => true,
        'magic_constant_casing' => true,
        'magic_method_casing' => true,
        'method_argument_space' => true,
        'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'],
        'native_function_casing' => true,
        'no_blank_lines_after_class_opening' => true,
        'no_blank_lines_after_phpdoc' => true,
        'no_closing_tag' => true,
        'no_empty_phpdoc' => true,
        'no_empty_statement' => true,
        'no_extra_blank_lines' => true,
        'no_leading_import_slash' => true,
        'no_leading_namespace_whitespace' => true,
        'no_mixed_echo_print' => true,
        'no_multiline_whitespace_around_double_arrow' => true,
        'no_short_bool_cast' => true,
        'no_singleline_whitespace_before_semicolons' => true,
        'no_spaces_after_function_name' => true,
        'no_spaces_around_offset' => true,
        'no_spaces_inside_parenthesis' => true,
        'no_trailing_comma_in_list_call' => true,
        'no_trailing_comma_in_singleline_array' => true,
        'no_trailing_whitespace' => true,
        'no_trailing_whitespace_in_comment' => true,
        'no_unneeded_control_parentheses' => true,
        'no_unused_imports' => true,
        'no_useless_else' => true,
        'no_useless_return' => true,
        'no_whitespace_before_comma_in_array' => true,
        'no_whitespace_in_blank_line' => true,
        'normalize_index_brace' => true,
        'object_operator_without_whitespace' => true,
        'ordered_imports' => ['sort_algorithm' => 'length'],
        'php_unit_fqcn_annotation' => true,
        'phpdoc_align' => ['align' => 'vertical'],
        'phpdoc_indent' => true,
        'phpdoc_inline_tag' => true,
        'phpdoc_no_access' => true,
        'phpdoc_no_package' => true,
        'phpdoc_no_useless_inheritdoc' => true,
        'phpdoc_order' => true,
        'phpdoc_scalar' => true,
        'phpdoc_separation' => true,
        'phpdoc_single_line_var_spacing' => true,
        'phpdoc_summary' => true,
        'phpdoc_to_comment' => true,
        'phpdoc_trim' => true,
        'phpdoc_types' => true,
        'phpdoc_var_without_name' => true,
        'psr4' => true,
        'self_accessor' => true,
        'short_scalar_cast' => true,
        'simplified_null_return' => true,
        'single_blank_line_at_eof' => true,
        'single_blank_line_before_namespace' => true,
        'single_class_element_per_statement' => true,
        'single_import_per_statement' => true,
        'single_line_after_imports' => true,
        'single_quote' => true,
        'space_after_semicolon' => true,
        'standardize_not_equals' => true,
        'switch_case_semicolon_to_colon' => true,
        'switch_case_space' => true,
        'ternary_operator_spaces' => true,
        'trailing_comma_in_multiline_array' => true,
        'trim_array_spaces' => true,
        'unary_operator_spaces' => false,
        'visibility_required' => true,
        'whitespace_after_comma_in_array' => true,
    ])
    ->setFinder($finder);

 

Розбирати кожне правило не буду, оскільки все описано в офіційній документації. Але про всяк випадок зазначу, що одні й ті ж правила можуть мати різні назви в StyleCI і PHP CS Fixer. Їх не так вже й багато, але все ж є.

3. Додамо в .gitignore файл .php_cs.cache. На даний момент такого файлу в проекті не існує, але він буде створюватися після кожного запуску fixer-а, і "тягти" його в репозиторій немає ніякого сенсу.

4. Відкриваємо консоль, запускаємо команду:

$ which php-cs-fixer

 

та копіюємо шлях. 

5. Відкриваємо PhpStorm Settings -> Tools -> External Tools і натискаємо на знак + в лівому верхньому кутку:

 

6. Заповнюємо форму, як на зображенні нижче:

PhpStrom - Create External Tool 

 

7. Потім натискаємо Ok і потім Apply. Переходимо в Settings -> Languages & Frameworks -> PHP -> Quality Tools:

PhpStorm - Quality Tool

 

8.Відкриваємо вкладку PHP CS Fixer в правій частині вікна і натискаємо на кнопці з трьома крапками праворуч від поля Configuration:

PhpStorm - Quality Tool - PHP CS Fixer

 

9. У вікні, натискаємо на іконці директорії праворуч від поля PHP CS Fixer path і знову вибираємо шлях до встановленого на Вашій машині бінарного файлу php-cs-fixer. Перевірити, чи правильний шлях, можна кнопкою Validate - внизу вікна має з'явитися відповідне повідомлення:

   

 

Натискаємо Apply и потом Ok

10. Наступний крок - "пояснити", де знаходиться файл конфігураціі. Заходимо в Settings -> Editor -> Inspections і відмічаємо чекбокс PHP -> Quality Tools -> PHP CS Fixer validation:

 

11. Якщо правила дозволяють (а в нашому випадку це так), ставимо галочку навпроти Allow risky rules, натискаємо на значок поновлення праворуч від поля Ruleset та вибираємо зі списку Custom:

PhpStorm - PHP CS Fixer validation, Custom

 

12. У тому ж вікні натискаємо на кнопку з трьома крапками. Потім у новому вікні Custom Coding Standard вибираємо шлях до файлу .php_cs.dist у корені проекту:

PhpStorm - Custom Coding Standard

 

Підтверджуємо вибір натиснувши Ok і потім Apply.

13. Все, що залишилося - призначити гарячі клавіші. Відкриваємо Settings -> Keymap та створюємо шорткат для php-cs-fixer:

 

Готово!

Як використовувати:
  1. Для форматування поточного файлу використовуйте комбінацію гарячих клавіш, яка була створена на попередньому кроці.
  2. Для форматування усіх файлів*  відкрийте консоль, перейдіть в корінь проекту і запустіть команду php-cs-fixer fix

*Не будуть відформатовані файли, які ми виключили в методах exclude і notPath в файлі конфігурації .php_cs.dist

 

На цьому все. Успіхів!