Команда WP-CLI wp dist-archive: создание архивов для плагинов WordPress

Команда wp dist-archive в WP-CLI предназначена для создания архивов из файлов плагинов WordPress. Она позволяет легко сформировать архив, исключая ненужные файлы с помощью специального файла .distignore. В этой статье мы разберем все аспекты команды, включая параметры, установку и примеры использования.

Установка команды wp dist-archive

Для начала необходимо установить пакет wp-cli/dist-archive-command, который добавляет поддержку команды wp dist-archive в WP-CLI. Установить его можно с помощью команды:

wp package install wp-cli/dist-archive-command

После успешной установки команда станет доступна для использования.

Основной синтаксис команды

Команда wp dist-archive имеет следующий формат:

wp dist-archive {path} [{target}] [--format={format}]

Аргументы

1. {path} (обязательный):
   Путь к проекту, где находится файл .distignore.
2. [{target}] (необязательный):
   Путь и имя создаваемого архива. Если не указано, архив будет назван в формате <имя-проекта>-<версия>.zip.
3. [--format={format}] (необязательный):
   Формат архива. Возможные значения:
   • zip (по умолчанию)
   • targz

Глобальные параметры

Команда поддерживает глобальные параметры WP-CLI, такие как:

• --path=<path>: Указывает путь к установке WordPress.
• --url=<url>: URL сайта для выполнения команды.
• --quiet: Отключает вывод сообщений в консоль.

Создание файла .distignore

Файл .distignore указывает, какие файлы и папки следует исключить из архива. Это особенно полезно для исключения конфигурационных файлов, тестовых данных и системных папок, которые не нужны в распространяемом архиве.

Пример .distignore:

.editorconfig
.git
.gitignore
.travis.yml
/tests/
circle.yml
README.md

1. Создание архива плагина

Рассмотрим плагин, расположенный в папке wp-content/plugins/hello-world. Чтобы создать архив, выполните следующую команду:

wp dist-archive wp-content/plugins/hello-world

После выполнения команды будет создан архив hello-world.zip в директории плагина.

2. Указание пользовательского имени архива

Чтобы создать архив с именем plugin-archive-v1.0.zip и сохранить его в папке backups, выполните:

wp dist-archive wp-content/plugins/hello-world backups/plugin-archive-v1.0.zip

3. Создание архива в формате targz

Если требуется архив в формате .tar.gz, укажите параметр --format:

wp dist-archive wp-content/plugins/hello-world backups/hello-world-archive.tar.gz --format=targz

4. Исключение файлов с помощью .distignore

Если в папке плагина есть файл .distignore, команда исключит указанные в нем файлы. Например, если .distignore содержит:

/tests/
/docs/
/.git/
.idea/

Команда:

wp dist-archive wp-content/plugins/hello-world

Создаст архив без указанных директорий и файлов.

Полезные советы

1. Проверяйте содержимое архива: После создания архива проверьте, что все нужные файлы включены.
2. Совместимость с версиями: Убедитесь, что указана правильная версия плагина, если имя архива формируется автоматически.
3. Интеграция в CI/CD: Команду wp dist-archive можно использовать в системах автоматизации сборки, таких как GitHub Actions, GitLab CI или Jenkins.

Заключение

Команда wp dist-archive в WP-CLI — это мощный инструмент для WordPress-разработчиков, упрощающий процесс создания архивов плагинов. Она позволяет исключать ненужные файлы, задавать форматы архивов и автоматизировать рутинные задачи. Используйте эту команду для повышения эффективности работы и упрощения распространения ваших плагинов.