Композитор для WordPress, частина 2

У цьому дописі я підсумую те, про що я почав ділитися вчора: використання інструментів і бібліотек, якими я поділився разом із Composer, щоб нюхати ваші коміти під час розробки до того, як код потрапить у репозиторій.

В ідеалі ви завжди захочете бачити щось подібне у своєму терміналі щоразу, коли ви фіксуєте свій код:

Але це не завжди так. Однак, як і в більшості інших речей, чим більше ви практикуєтеся, тим більше звикнете писати код, який автоматично пропускатиме різні нюхання, встановлені різними правилами (та їхніми налаштуваннями).

Перш ніж це зробити, ви повинні налаштувати GrumPHP у своєму репозиторії.

Композитор для WordPress: фіксація комітів

Учора я надав зразок composer.json , тому сьогодні ми розглянемо зразок конфігураційного файлу GrumPHP і розглянемо, що робить кожна частина.

Важливо зауважити, що хоча деякі з того, що ви побачите, не є нетиповим для проекту, ви можете налаштувати це як завгодно для кожного проекту, який використовуєте. Іноді вам може знадобитися, щоб він був більш зосередженим, ніж зараз; іноді, ви можете не дбати про деякі нюхи, які він пропонує.

Початкова конфігурація

Тим не менш, після встановлення GrumPHP буде створено майже порожній grumphp.ymlфайл, готовий до налаштування. Наприклад, ось що ви повинні побачити :

parameters:
    git_dir:. bin_dir: vendor/bin
    tasks:

Зауважте, що в цьому немає нічого, крім вказівки:

• місце розташування сховища,
• розташування двійкових файлів, встановлених через Composer,
• завдання для виконання.

Зауважте, що я завжди використовував «.» для розташування мого сховища, оскільки я ніколи не встановлював його в сховищі, над яким працюю.

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

І, нарешті, початкова tasksдиректива порожня, тому що насправді ще немає нічого для запуску. Це те, що я розгляну в наступному кроці.

Налаштування GrumPHP

Коли ви встановите свої бібліотеки та будете готові трохи налаштувати конфігурацію, можливо, ви зможете зробити щось подібне до цього :

parameters:
    git_dir:. bin_dir: vendor/bin
    tasks:
      securitychecker:
      composer:
      jsonlint:
      xmllint:
      yamllint:
      phpstan:
      phplint:
      phpunit:
      phpcs:
      phpcpd:
      phpmnd:
      phpparser:
        visitors:
          no_exit_statements: ~
          never_use_else: ~
          forbidden_function_calls:
            blacklist:
              - "die"
              - "var_dump"
              - "exit"
      phpversion:
        project: '7.0'
       phpmd:
         ruleset: ['phpmd.xml.dist']

Я не буду описувати все вище (оскільки нема чого окреслювати), але є ще кілька речей, на які варто звернути увагу:

• Зауважте, що існує набагато довший список завдань, ніж той, який був визначений у початковому каталозі. Це нормально, і це означає, що ми хочемо запускати ці інструменти, використовуючи конфігурацію за замовчуванням для кожного з цих інструментів.
• Кілька правил є ~поруч. Це залежить від завдання, яке розглядається, але зазвичай це означає, що ми хочемо використовувати конфігурацію за замовчуванням.
• Є такі завдання, phpparserякі мають підзадачі. Деякі з них, як ви бачите вище, використовують поведінку за замовчуванням. Інші вибирають такі терміни, як die, var_dump, exitтощо. Це означає, що якби директива була недостатньо чіткою, ми призведемо до збою GrumPHP, якщо буде виявлено будь-який із цих операторів.
• Так само подивіться на phpmd. Це вказує на набір правил, які ми будемо використовувати, шукаючи різні безлади в коді. У цьому випадку він вказує на dist файл, але може вказувати на будь-який спеціальний набір правил, який ви визначили.

Це лише приклад того, що ви можете робити з GrumPHP. Тобто ви можете інсталювати деякі бібліотеки за допомогою Composer, установити їх, а потім налаштувати GrumPHP так, щоб ви могли скористатися перевагами наданої функціональності.

Як і в інших подібних проектах, я настійно рекомендую прочитати документацію, яка існує для різних завдань, які інтегруються з GrumPHP.

Це Composer для WordPress?

Так і ні. Composer — це менеджер пакунків загального призначення для PHP-проектів; однак, здається, ми не бачимо цього в світі WordPress. Це не означає, що він не використовується (це є), але просто знати про Composer і про те, як ним користуватися, недостатньо.

Натомість я вважаю, що важливо знати, як використовувати Composer для WordPress, щоб ми могли писати найвищий рівень якості коду й водночас переконатися, що ми дотримуємося будь-яких стандартів кодування, які ми також вирішили використовувати .