Composer часть 2. Создание собственной библиотеки. Загрузка на Packagist

Composer часть 2. Создание собственной библиотеки. Загрузка на Packagist

  • 17 мая, 2022
  • читать 10 мин
Денис Розганяев
Денис Розганяев Software Engineer в Mobilunity, Преподаватель Компьютерной школы 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>

P.S.: для удобства лучше использовать версии вашего проекта, таким образом пользователи смогу выбирать себе версию вашей библиотеки сами:

git tag 1.0.0

git push origin 1.0.0

Начните изучать PHP! Курсы ведут только практикующие специалисты 👇

Нажимай и выигрывай от
1 000 до 5 000 ₴