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

Останнє оновлення Лис 9, 2022

Зміст

Гаразд, тож після розмови про всі різноманітні бібліотеки, які можуть допомогти покращити якість коду вашої роботи, все одно виникає запитання:

Як змусити ці проекти працювати з нашою кодовою базою?

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

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

Налаштування Composer для WordPress

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

Зразок каталогу

Припустімо, на мить ви збираєтеся розпочати роботу над плагіном або чимось, пов’язаним із WordPress, для чого знадобляться різні бібліотеки, розглянуті в попередній серії. І під час налаштування каталогу для цього у вас буде дуже мало файлів. Може пара порожніх файлів PHP, assets і т.д. Можливо це буде виглядати так:

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

Є composer.lock файл, який показує, що Composer було виконано,
У ньому є vendor каталог, який показує бібліотеки, встановлені через Composer,
Існує grumphp.yml файл, який визначає, як повинен працювати GrumPHP (я розповім про це пізніше) під час нюхання коду.

Але суть вищезазначеного та сама: у вас є, composer.jsonі це визначає та включає все, що нам потрібно на основі попередньої публікації. Отже, як ми це налаштуємо?

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

По-перше, вам потрібно мати уявлення про те, як ви збираєтеся структурувати свій плагін. Наприклад, я маю такий плагін:

Усі файли PHP знаходяться в src каталозі,
Усі файли CSS, JavaScript, зображення тощо знаходяться в assets каталозі,
Каталог vendor призначений для речей, які встановлено через Composer,
views це те, що використовується в інтерфейсі проекту.

Наприклад:

По-друге, у каталозі, про який йде мова, ви захочете створити файл під назвою composer.json. Це можна зробити через термінал, просто видавши touch команду, або ви можете створити її у своєму IDE.

Важливим моментом є те, що існує src каталог, тому що це каталог, який містить наші файли PHP, і це каталог, який ми хочемо пронюхати.

Базовий файл композитора

З огляду на це, ось основний файл, який ви можете використовуватиcomposer.json у своїх проектах на основі попередньої серії та на основі того, що наведено нижче:

{
  "name": "pressware/demo-wordpress-plugin",
  "description": "This file is used to show how to configure a WordPress plugin using Composer.",
  "autoload": {
    "psr-4": {
      "Pressware": "src/"
    }
  },
  "require-dev": {
    "phpro/grumphp": "^0.11.6",
    "phpmd/phpmd": "^2.6",
    "phpunit/phpunit": "5.7.21",
    "nikic/php-parser": "^3.0",
    "sebastian/phpcpd": "^3.0",
    "povils/phpmnd": "^1.1",
    "squizlabs/php_codesniffer": "^3.0",
    "jakub-onderka/php-parallel-lint": "^0.9.2",
    "sensiolabs/security-checker": "^4.0"
  }
}

Дивлячись на файл вище, ось як його розібрати:

Рядки 2 і 3 дають невеликий опис суті плагіна. Це також інші області в цьому файлі, щоб надати більше інформації про те, що потрібно зробити.
Рядки з 4 по 8 важливі, оскільки вони пояснюють, що ми використовуємо PSR-4 для автозавантаження, і що всі файли підпадають під простір імен верхнього рівня, Presswareа файли PHP знаходяться в src каталозі.
Рядки 9–18 охоплюють усі файли, які розглядалися в попередній серії.

Далі виконайте таку команду у вашому терміналі:

$ composer install

І це встановить ці пакети.

Що щодо комітів?

Щоб переконатися, що ви належним чином гасите та обробляєте коміти, важливо налаштувати GrumPHP так, щоб він спостерігав за файлами. Але я розгляну це в наступній публікації.

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

Джерело запису: tommcfarlin.com