/phpcs

Webpractik PHP Code standarts

Primary LanguagePHP

Webpractik PHP Code standards

Стандарт наследуется от @PSR-12 (рус) за исключением:

  • Длина строки (шаблоны в Bitrix сложно валидировать)
  • Отключение требования не использовать пользовательский код вместе с классами (в Bitrix нужно порой вызывать модуль или компонент перед определением класса в связи со своей системой autoload)

Репозиторий содержит в себе

  1. Стандарт для phpcs
  2. Конфиг для php-cs-fixer

Установка

Устанавливаем глобально в систему. Не забываем что у вас в системе должен быть прописан path к /vendor/bin/.

composer global require webpractik/php_code_style

Устанавливаем путь к стандарту по умолчанию для phpcs

# 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 иногда может некорректно реагировать на '~', и прийдется прописать полный путь к файлу. Также может быть проблема если у вас в имени есть пробел. Решается симлинком.

Настройка редакторов