Укр Рус
Composer частина 2. Створення власної бібліотеки. Завантаження на Packagist

Composer частина 2. Створення власної бібліотеки. Завантаження на Packagist

  • 17 травня
  • читати 10 хв
Денис Розганяєв
Денис Розганяєв PHP Developer у SoftServe, Викладач Комп'ютерної школи Hillel.

Ми почали з того, що таке Composer і навіщо він потрібний:

Рекомендуємо публікацію по темі

Тепер ми розберемо покрокове створення міні-проекту мовою PHP та додамо його на сервіс packagist.

Створення проекту

Спершу необхідно створити публічний GIT репозиторій, у моєму випадку це буде github.com.

Ініціалізація composer проекту

Після цього клонуємо репозиторій на комп'ютер і заходимо в директорію проекту, де необхідно створити файл composer.json. Можна створити його вручну, але composer має команду спеціально для цього — composer init.

Прописати цю команду треба докорінно проекту, після чого composer покроково задаватиме вам всі необхідні питання для заповнення даного файлу.

По зображенню вище видно питання, які задає composer під час ініціалізації проекту.

  • Package name (<vendor>/<name>) — запитує назву вашого проекту. Також можна використати запропонований варіант від composer
  • Description — опис проекту
  • Author — дані про автора, зазвичай підтягує дані з репозиторію
  • Minimum Stability — визначає стандартну поведінку для фільтрації пакетів за стабільністю. Типове значення stable
  • Package Type — визначає тип пакету (вашого проекту). Типово – library
  • License — Визначає ліцензію вашого пакета (детальніше тут)

Детальніше про composer.json можна переглянути за посиланням. Після створення файл конфігурації буде виглядати так:

У require можна вписати всі необхідні залежності для вашого проекту.

README файл

Кожен проект повинен мати README.md файл, в якому буде написано інструкцію з встановлення та використання цієї бібліотеки. Приклад заповнення такого файлу можна переглянути на цьому ресурсе.

Packagist

Packagist має сторінку реєстрації, але найлегший спосіб — це авторизація через github, як показано на зображенні нижче.

Реєстрація пакету

Зареєструвати вашу бібліотеку можна за посиланням або просто натиснути на Submit у верхньому меню. Далі вставляєте посилання на ваш репозиторій та натискаєте на кнопку Check.

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

Підключення вашої бібліотеки можливе за командою composer require <vendor>/<name>

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

git tag 1.0.0

git push origin 1.0.0

Почніть вивчати PHP! Курси ведуть лише практикуючі спеціалісти 👇

Рекомендуємо курс по темі