Додавання кількох стандартів кодування за допомогою Composer

Одна справа — використовувати PHP CodeSniffer вручну, але якщо ви користуєтеся утилітою на кшталт GrumPHP, щоб перевірити свою роботу перед тим, як передати її до репозиторію, то, швидше за все, вам захочеться використовувати версію, яку ви встановлюєте зі своїм демонструвати.

Це передбачає, що:

1. Ви встановлюєте PHP CodeSniffer локально у свій проект,
2. Ви хочете встановити певний набір стандартів кодування для роботи з вашим кодом.

Пам’ятайте, що це також робиться в контексті бажання запускати автоматизовані сценарії під час процесу фіксації та в локальному середовищі (а не в глобальних налаштуваннях) за допомогою Composer.

Composer пропонує можливість писати сценарії під час виконання. З посібника :

Сценарій, з точки зору Composer, може бути зворотним викликом PHP (визначеним як статичний метод) або будь-якою командою командного рядка, що виконується. Сценарії корисні для виконання спеціального коду пакета або специфічних для пакета команд під час виконання Composer.

Щоб установити кілька стандартів кодування за допомогою Composer, щоб ми могли робити те, що ми з GrumPHP і будь-яким попереднім процесом, нам потрібно скористатися перевагами сценаріїв pre-install-cmd і pre-update-cmd. Це забезпечить встановлення належних стандартів кодування для двійкового файлу PHP CodeSniffer на рівні проекту.

Приклад :

"scripts": {
    "post-install-cmd": [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress"
    ],
    "post-update-cmd":  [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress"
    ],
},

Зауважте, що в наведеному вище прикладі я обов’язково додаю стандарти кодування WordPress до PHP CodeSniffer.

Але ви можете додати кілька версій стандартів кодування, наприклад:

"scripts": {
    "post-install-cmd": [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress-Core,/Users/tommcfarlin/Sync/Projects/wpcs/WordPress-VIP"
    ],
    "post-update-cmd":  [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress-Core,/Users/tommcfarlin/Sync/Projects/wpcs/WordPress-VIP"
    ],
},

І ви можете додати будь-які інші наявні у вас стандарти, які дозволять вам вказувати сценарій у належному місці, де вони встановлені.

Щойно ви це зробите, стандарти будуть застосовані до PHP CodeSniffer і виконуватимуться під час процесів встановлення та оновлення Composer.