php cs fixer config
Php cs fixer config
Pick one of the rule sets:
Configuration with header
💡 Optionally specify a header:
Configuration with override rules
💡 Optionally override rules from a rule set by passing in an array of rules to be merged in:
If you like Makefile s, create a Makefile with a coding-standards target:
to automatically fix coding standard violations.
If you like composer scripts, add a coding-standards script to composer.json :
to automatically fix coding standard violations.
If you like GitHub Actions, add a coding-standards job to your workflow:
This package is licensed using the MIT License.
Curious what I am building?
📬 Subscribe to my list, and I will occasionally send you an email to let you know what I am working on.
About
📓 Provides a configuration factory and multiple rule sets for friendsofphp/php-cs-fixer.
php-cs-fixer: Пишем свой фиксер
Фиксер?
Вообще, что такое фиксер? Фиксер, это небольшой класс, который фиксит ваш код, приводит его к какому-то виду. Я не стал выдумывать глупые или сложные кейсы для нового фиксера, и решил взять какой-нибудь вполне реальный. Например, приведение всех ключевых слов в коде к нижнему регистру. За это отвечает фиксер LowercaseKeywordsFixer. Давайте на его примере научимся создавать собственные фиксеры.
Фиксим
Итак, вы уже выполнили
Наш подопытный фиксер состоит из двух частей:
Сам фиксер:
src/Fixer/Casing/LowercaseKeywordsFixer.php
И тест:
tests/Fixer/Casing/LowercaseKeywordsFixerTest.php
LowercaseKeywordsFixer.php — это файл, который содержит класс фиксера. Каждый фиксер должен наследоваться от абстрактного класса PhpCsFixer\AbstractFixer, а значит содержать методы:
К этим методам мы еще вернемся. Давайте теперь рассмотрим очень важное для нас понятие: Token.
Token в PHP
Если вы хорошо знакомы с PHP, то понятие токенов для вас не ново. На русском их еще иногда называют “метками”. Токены — это языковые лексемы PHP. Например, если взять такой простенький код:
и разбить его на токены, то получим массив из 54 элементов. Вторым элементом будет:
Где 334 — это идентификатор токена. То есть не этого конкретного токена, а этого типа токенов. Другими словами, все токены, представляющие конструкцию foreach — будут иметь идентификатор 382. Этому идентификатору соответствует константа T_FOREACH. Список всех констант можно посмотреть в документации.
Очень важный момент. Идентификаторы меняются от версии к версии PHP интерпретатора, ваш код никогда не должен зависеть от конкретных цифр, только константы!
Подробнее про токены можно почитать в документации.
Token в php-cs-fixer
В php-cs-fixer есть два класса для работы с токенами:
PhpCsFixer\Tokenizer\Tokens для работы с массивом токенов, и
PhpCsFixer\Tokenizer\Token для работы с одним токеном.
Рассмотрим некоторые полезные методы.
Проверяет, что переданный первым параметром токен эквивалентен текущему. Это самый правильный способ проверить, что токены равны.
Проверяет, что один из переданных в первом параметре токенов равен текущему.
Получить содержимое токена.
Задать содержимое токена.
Был ли токен уже модифицирован.
Названия говорят сами за себя.
Подробнее
Сгенерировать PHP код из набора токенов.
Найти следующий токен определенного типа
Найти следующий/предыдущий токен, содержащий что-то, кроме пробелов и комментариев.
Пишем фиксер
Теперь к самому фиксеру.
Напомню, что мы пишем фиксер, который приводит все ключевые слова PHP к нижнему регистру. Класс фиксера будет находиться в файле
src/Fixer/Casing/LowercaseKeywordsFixer.php
Для начала нам нужно определить, попадает ли код под наш кейс. В нашем случае нам надо обработать любой код, который содержит ключевые слова php. Определим метод isCandidate.
Теперь нам нужно описать наш фиксер. Для этого определим метод:
Этот метод возвращает объект FixerDefinition, конструктор которого принимает два параметра: короткое описание фиксера (оно будет в документации в файле README.rst) и небольшой пример кода для исправления (он нигде отображаться не будет, но участвует в тестах).
Также мы можем реализовать метод
Который возвращает приоритет фиксера, если нам понадобится запускать свой фиксер до или после других фиксеров. В нашем случае, наш фиксер никак не зависит от остальных, так что можно не реализовывать метод, оставив значение 0 из родительского класса.
Все приготовления закончены, давайте реализуем метод, который будет фиксить код.
Нам нужно, пробежать по всему коду, если токен — ключевое слово, то привести его к нижнему регистру:
В итоге должен получиться примерно такой файл.
Что дальше
У нас есть работающий фиксер. Это здорово. Осталось совсем чуть-чуть. Давайте напишем для него тест. Наш тест будет находиться в файле
tests/Fixer/Casing/LowercaseKeywordsFixerTest.php
Это обычный PHPUnit тест, разве что у него есть свой метод
который первым параметром принимает ожидаемый результат, а вторым — первоначальный код. Тестовый метод:
Напишем провайдер данных:
В итоге получаем такой код.
Тест работает, и если запустить только его, то все пройдет успешно. А вот общий тест сфейлится, т.к. данных о нашем фиксере нет в документации. Документация в php-cs-fixer авто-генерируемая, значит, достаточно запустить:
И информация о нашем фиксере добавится в документацию.
Теперь нужно проверить оба наших файла на предмет соответствия код стайлу:
Ну и в конце концов запустить общий тест:
Если все прошло успешно, то ваш собственный фиксер готов. Далее можно сделать пулл реквест и через какое-то время ваше творение появится в php-cs-fixer.
Php cs fixer config
PHP Coding Standards Fixer
The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards; whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc., or other community driven ones like the Symfony one. You can also define your (team’s) style through configuration.
It can modernize your code (like converting the pow function to the ** operator on PHP 5.6) and (micro) optimize it.
If you are already using a linter to identify coding standards problems in your code, you know that fixing them by hand is tedious, especially on large projects. This tool does not only detect them, but also fixes them for you.
The recommended way to install PHP CS Fixer is to use Composer in a dedicated composer.json file in your project, for example in the tools/php-cs-fixer directory:
For more details and other installation methods, see installation instructions.
Assuming you installed PHP CS Fixer as instructed above, you can run the following command to fix the files PHP files in the src directory:
See usage, list of built-in rules, list of rule sets and configuration file documentation for more details.
If you need to apply code styles that are not supported by the tool, you can create custom rules.
Dedicated plugins exist for:
The PHP CS Fixer is maintained on GitHub at https://github.com/FriendsOfPHP/PHP-CS-Fixer. Bug reports and ideas about new features are welcome there.
You can reach us at https://gitter.im/PHP-CS-Fixer/Lobby about the project, configuration, possible improvements, ideas and questions, please visit us!
The tool comes with quite a few built-in fixers, but everyone is more than welcome to contribute more of them.
About
A tool to automatically fix PHP Coding Standards issues
PHP CS Fixer
In addition to built-in coding assistance, PhpStorm provides checking the source code through integration with the PHP CS Fixer tool, which detects coding standards problems in your code.
To use PHP CS Fixer from PhpStorm instead of command line, you need to register it in PhpStorm and configure it as a PhpStorm code inspection. Once installed and enabled in PhpStorm, the tool is available in any opened PHP file, and no additional steps are required to launch it. The on-the-fly code check is activated upon every update in the file thus making it easy to get rid of discovered problems.
Errors and warnings reported by PHP CS Fixer on-the-fly are displayed as popup messages. When the tool is run in the batch mode, the errors and warnings are displayed in the Inspection Results tool window. Each message has the PHP CS Fixer prefix to distinguish it from PhpStorm internal inspections.
You can have predefined rules applied or define your own custom set of rules.
Prerequisites
Prior to integrating PHP CS Fixer in PhpStorm, make sure the following prerequisites are met:
You are working with PHP CS Fixer version 2.8.0 and later.
For Docker Compose-based remote interpreters, make sure to use exec mode to avoid spawning additional containers.
Install and configure PHP CS Fixer
PHP CS Fixer scripts can be used as local scripts, the scripts associated with PHP interpreters, or scripts declared as project dependencies and installed via Composer, which is the preferable and recommended way.
Install PHP CS Fixer with Composer
Before you start, make sure Composer is installed on your machine and initialized in the current project as described in Composer dependency manager.
When you install PHP CS Fixer with Composer, PhpStorm automatically downloads the necessary scripts, registers them in the IDE, and, optionally, enables and configures the corresponding code inspection.
Do one of the following:
Click the Install shortcut link on top of the editor panel.
If the Non-installed Composer packages inspection is enabled, PhpStorm will highlight the declared dependencies that are not currently installed. Press Alt+Enter and select whether you want to install a specific dependency or all dependencies at once.
Reset PHP CS Fixer configuration
After PHP CS Fixer is initially configured, further modifications in composer.json will not affect the inspection configuration. To apply newer changes, reset the PHP CS Fixer configuration.
In the PHP CS Fixer dialog that opens, empty the PHP CS Fixer path field.
Update the project Composer dependencies by clicking Update on top of the composer.json editor panel. See Update dependencies for details.
Configure PHP CS Fixer manually
Choose a PHP CS Fixer script to use
On the Quality Tools page that opens, expand the PHP CS Fixer area. From the Configuration list, choose the PHP CS Fixer script:
To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
Configure a local PHP CS Fixer script
Download and install the PHP CS Fixer scripts.
To check the PHP CS Fixer installation, switch to the installation directory and run the following command:
If the tool is available, you will get a message in the following format:
Register the local PHP CS Fixer script in PhpStorm:
If necessary, in the Tool process timeout field, specify how long you want PhpStorm to wait for a result from PHP CS Fixer, whereupon the process is terminated to prevent excessive CPU and memory usage.
Configure a PHP CS Fixer script associated with a PHP interpreter
If necessary, in the Tool process timeout field, specify how long you want PhpStorm to wait for a result from PHP CS Fixer, whereupon the process is terminated to prevent excessive CPU and memory usage.
Configure PHP CS Fixer as a PhpStorm inspection
Configure the PHP CS Fixer inspection with Composer
After PHP CS Fixer is initially configured, further modifications in composer.json will not affect the inspection configuration. To apply newer changes, reset the PHP CS Fixer configuration on the PHP | Quality Tools page of the Settings/Preferences dialog Ctrl+Alt+S and update project dependencies.
Configure the PHP CS Fixer inspection manually
On the right-hand pane of the page, configure the PHP CS Fixer tool using the controls in the Options area:
From the Severity list, choose the severity degree for the PHP CS Fixer inspection. The selected value determines how serious the detected discrepancies will be treated by PhpStorm and presented in the inspection results.
From the Scope list, choose the scope to limit the inspection application to.
To allow risky rules, that is, the rules that can change code behavior, select the Allow risky rules for built-in rulesets checkbox. By default, risky rules are not allowed.
Appoint the coding standard to apply.
To use one of the predefined coding standards, select it the Coding standard list, appoint the coding style to check your code against. The list contains all the coding standards declared inside the main php-cs-fixer directory structure.
Share a custom coding style with the team
Put the root directory of your coding standard under the project root.
Run PHP CS Fixer in the batch mode
View the inspection results in the Inspection results tool window. Errors and warnings reported by PHP CS Fixer are prefixed with PHP CS Fixer to distinguish them from PhpStorm internal inspections.
Exclude files from PHP CS Fixer inspection
On the Quality Tools page that opens, expand the PHP CS Fixer area and click the Show ignored files link.
Php cs fixer config
Автоформатирование кода: PHP CodeSniffer и PHP CS Fixer
На laracasts есть замечательное видео по этой теме в контексте PhpStorm, здесь же пойдёт речь о том, чего не рассказывал в том видео Джефри (ну а если хотите настроить фиксер под Sublime, смотрите эту статью).
PHP CodeSniffer
Давайте начнём с PHP CodeSniffer. Этот инструмент поможет выявить нарушения форматирования, при надлежащей настройке PhpStorm будет вас об этом информировать путём выделения проблемных частей кода. Кроме всего прочего мы можем воспользоваться консолью для вывода информации об ошибках.
Установка
Используемый стандарт
Также хорошенько подумайте о том, достаточно ли набора правил стандарта. Вполне возможно, что ответ будет отрицательным. Перечитайте документацию, и добавьте те, которые Вам понадобятся.
Можно каждый раз в консоли руками пописывать какие-то дополнительные правила или условия, указывать стандарт и т.д. Но, мы же понимаем, что это не оптимальный вариант. Поэтому, в корне проекта создадим файл phpcs.xml и добавим туда следующее (в качестве примера использую код из текущего проекта):
Пояснения:
Основные команды
Вывести список установленных стандартов:
Вывести список снифов, используемых в конкретном стандарте:
Проверить форматирование файла file.php :
Проверить весь проект :
Проверить весь проект с выводом информации о том, где конткретно были встречены ошибки:
Вывести код-репорт, т.е. отчёт со сниппетами кода, где были обнаружены ошибки:
Есть ещё и другие команды, но, по моему мнению, вполне хватает перечисленных. Справедливости ради стоит отметить, что PHP CoedSniffer также включает и code beautifier fixer, т.е. можно исправить ошибки (читай отформатировать) командой:
но я всё же предпочитаю php-cs-fixer
PHP CS Fixer
Установка
Опять-таки подумайте устанвливать интсрумент глобально, или для каждого проекта. Второй вариант:
Если выбираете глобальную установку, убедитесь, что в переменную PATH добавлен путь к бинарным файлам composer-a. Проверьте это командой:
Пользовательские правила
Автоформат
Основные команды
Вывести список команд:
Вывести описание правил входящих в конкретный стандарт:
И, как уже был сказано, отформатировать (для разнообразия укажем стандарт Symfony):
В случае с fixer-ом я предпочитаю использовать не консоль, а настроить PhpStorm для использования этого инструмента, добавить горячие клавиши и использовать по месту в конкретных файлах.
Git pre-commit hook
Подведём итоги. Мы используем:
Внимание: php-cs-fixer исправит только те ошибки, которые он может исправить, не более. Например, если у Вас не написан phpdoc, fixer за вас его не напишет. Помните об этом.