Добавление вашего плагина WordPress в Packagist

Когда вы начнете добавлять свои плагины WordPress на GitHub, одна из следующих вещей, которую вы, вероятно, захотите сделать, — это облегчить другим разработчикам процесс включения этих пакетов в их файл composer.json .

То есть им не нужно скачивать ваш плагин, включать его в ваш проект, следить за обновлениями и тому подобное. Вместо этого они добавляют файл, а затем запускают:

$ composer update

…когда они будут готовы получить последнюю версию вашей работы.

Но просто поделиться своей работой с GitHub недостаточно. Вы должны отправить свой плагин WordPress в Packagist (конечно, это работает и с другими проектами, но на самом деле это выходит за рамки этого блога).

И вот как это сделать.

Добавьте свой плагин WordPress в Packagist

Для тех, кто не в курсе, вот суть:

Packagist — это основной репозиторий Composer . Он объединяет общедоступные пакеты PHP, устанавливаемые с помощью Composer.

Короче говоря, это позволяет легко включать сторонние библиотеки в ваши проекты через Composer.

В любом случае, как только ваш плагин появится на GitHub, вам нужно будет выполнить еще несколько шагов, чтобы ваша работа была готова к регистрации в Packagist. Однако это легко:

1. Если вы еще этого не сделали, создайте учетную запись в Packagist,
2. Добавьте файл composer.json в свой проект и убедитесь, что он включает следующее :

{
  "name": "tommcfarlin/cmb2-featured-mobile-image",
  "type": "wordpress-plugin",
  "license": "GPL",
  "description": "Select an image to display as your featured image in the mobile version of your site.",
  "homepage": "https://github.com/tommcfarlin/cmb2-featured-mobile-image",
  "authors": [
    {
      "name": "Tom McFarlin",
      "email": "tom@tommcfarlin.com",
      "homepage": "https://github.com/tommcfarlin"
    }
  ],
  "keywords": [
    "wordpress"
  ],
  "support": {
    "issues": "https://github.com/tommcfarlin/cmb2-featured-mobile-image/issues"
  },
  "require": {
    "php": ">=7.0",
    "composer/installers": "~1.0",
    "hassankhan/config": "^0.10.0",
    "symfony/yaml": "^3.2"
  },
  "require-dev": {
    "squizlabs/php_codesniffer": "2.9.0"
  }
}

После этого обязательно обновите Composer, чтобы сгенерировать файл composer.lock. Оттуда перейдите на страницу отправки и добавьте URL-адрес в свой репозиторий GitHub.

Оттуда вы и любой другой человек сможете добавить ссылку в соответствующий файл composer.json своего проекта, а затем включить его в свой проект.

Пример

Рабочий пример того, как это может выглядеть, см. в этом проекте. (И у меня будет больше информации об этом конкретном проекте в следующем посте.)