https://github.com/avto-dev/php-cs-fixer
A tool to automatically fix PHP code style
https://github.com/avto-dev/php-cs-fixer
codestyle fixer package php
Last synced: 6 months ago
JSON representation
A tool to automatically fix PHP code style
- Host: GitHub
- URL: https://github.com/avto-dev/php-cs-fixer
- Owner: avto-dev
- License: mit
- Created: 2017-11-07T17:20:56.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-03T04:14:29.000Z (over 1 year ago)
- Last Synced: 2024-11-07T16:17:06.258Z (about 1 year ago)
- Topics: codestyle, fixer, package, php
- Language: PHP
- Size: 67.4 KB
- Stars: 4
- Watchers: 1
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Автоматический Code Style Fixer для PHP
[![Version][badge_packagist_version]][link_packagist]
[![Version][badge_php_version]][link_packagist]
[![Build Status][badge_build]][link_build]
[![Downloads count][badge_downloads_count]][link_packagist]
[![License][badge_license]][link_license]
Данный пакет для `composer` позволяет запускать автоматический `Code Style Fixer` для `PHP` с фиксированным набором правил, принятых в качестве основных для оформления исходного `php` кода.
## Install
Require this package with composer using the following command:
```shell
$ composer require avto-dev/php-cs-fixer "^1.6"
```
> Installed `composer` is required ([how to install composer][getcomposer]).
## Использование
В директории с вашим приложением выполните в терминале:
```shell
$ php ./vendor/bin/cs-fix
```
Опционально можете передать свои параметры запуска. При передаче параметра `--config` - все параметры, что формирует данный пакет - будут проигнорированы, и будет произведен запуск именно с теми параметрами, что будут переданы вами.
Если вам требуется опционально переопределить переопределить параметры правил fixer-а, то создайте в корне вашего приложения файл `.cs_rules.php`, возвращающий ассоциированный массив правил (более подробно о самих правилах можешь ознакомиться по [этой ссылке][vendor_fixer]). При его наличии его контент будет мерджиться с конфигом пакета, опционально перекрывая необходимые правила. Иметь он должен следующий вид:
```php
true,
'@PHP71Migration' => true,
'binary_operator_spaces' => [
'operators' => [
'=' => 'align_single_space',
'=>' => 'align_single_space',
],
],
'blank_line_after_namespace' => true,
'blank_line_after_opening_tag' => true,
];
```
Так же в корне можете разместить файл `.cs_excludes.php`, содержащий пути директорий, которые следует исключить при обработке, вида:
```php