https://github.com/webpractik/phpcs
Webpractik PHP Code standarts
https://github.com/webpractik/phpcs
Last synced: 10 months ago
JSON representation
Webpractik PHP Code standarts
- Host: GitHub
- URL: https://github.com/webpractik/phpcs
- Owner: webpractik
- Created: 2017-04-10T21:19:54.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-20T11:14:12.000Z (almost 3 years ago)
- Last Synced: 2024-09-26T03:36:47.247Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Webpractik PHP Code standards
Стандарт наследуется от [@PSR-12](https://www.php-fig.org/psr/psr-12/) ([рус](https://github.com/MiklyxoMaklai/rus-PSR/blob/master/accepted/psr-12.md)) за исключением:
- Длина строки (шаблоны в Bitrix сложно валидировать)
- Отключение требования не использовать пользовательский код вместе с классами (в Bitrix нужно порой вызывать модуль или компонент перед определением класса в связи со своей
системой autoload)
Репозиторий содержит в себе
1. Стандарт для [phpcs](https://github.com/squizlabs/PHP_CodeSniffer)
2. Конфиг для [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer)
## Установка
Устанавливаем глобально в систему. Не забываем что у вас в системе должен быть прописан path к [/vendor/bin/](https://github.com/webpractik/phpcs/blob/master/doc/linux-vendor.md).
```bash
composer global require webpractik/php_code_style
```
Устанавливаем путь к стандарту по умолчанию для phpcs
```bash
# linux
phpcs --config-set installed_paths "$HOME/.config/composer/vendor/webpractik/php_code_style"
# linux kde
phpcs --config-set installed_paths $HOME/.composer/vendor/webpractik/php_code_style
# windows
phpcs --config-set installed_paths "~/AppData/Roaming/Composer/vendor/webpractik/php_code_style"
```
Если вы правильно сделали, то при наборе в консоли `phpcs -i` у вам должен появиться стандарт Webpractik среди прочих.
Примечание: в windows иногда может некорректно реагировать на '~', и прийдется прописать полный путь к файлу. Также может быть проблема если у вас в имени есть пробел. Решается
симлинком.
## Настройка редакторов
- [phpstorm](https://github.com/webpractik/phpcs/blob/master/doc/phpstorm.md)
- [sublime-text](https://github.com/webpractik/phpcs/blob/master/doc/sublime.md)