Использование Plugman для управления плагинами

Начиная с версии 3.0, Cordova реализует все API устройства в виде плагинов и по умолчанию отключает их. Он также поддерживает два разных способа добавления и удаления плагинов, в зависимости от выбранного вами рабочего процесса, описанного в Обзоре:

• Если вы используете кроссплатформенный рабочий процесс, вы используете утилиту cordova командной строки для добавления плагинов, как описано в Интерфейсе командной строки. Командная строка изменяет плагины для всех указанных платформ одновременно.

• Если вы используете ориентированный на платформу рабочий процесс, вы используете более низкоуровневый Plugman интерфейс командной строки, отдельно для каждой целевой платформы.

В этом разделе подробно описана утилита Plugman. Дополнительную информацию о использовании Plugman в качестве модуля node или модификации исходного кода см. в файле README в его репозитории.

Установка Plugman

Для установки plugman, необходимо иметь node на вашей машине. Затем вы можете выполнить следующую команду из любой точки вашей среды для глобальной установки plugman, чтобы он был доступен из любой директории:

$ npm install -g plugman

Также необходимо иметь git на вашей PATH, чтобы иметь возможность устанавливать плагины непосредственно из удаленных URL-адресов git.

СОВЕТ: Если вы обнаружите, что после установки plugman с помощью npm, вы по-прежнему не можете выполнить какие-либо plugman команды, убедитесь, что вы добавили директорию /npm/ в вашу PATH.

ПРИМЕЧАНИЕ: Вы можете пропустить этот шаг, если не хотите загрязнять ваш глобальный npm пространство имён, устанавливая Plugman глобально. В этом случае, при создании проекта Cordova с инструментами командной строки, будет директория node_modules внутри вашего проекта, содержащая Plugman. Поскольку вы не установили его глобально, вам необходимо вызывать node для каждой команды Plugman, например node ./node_modules/plugman/main.js -version. Остальная часть этого руководства предполагает, что вы установили Plugman глобально, что означает, что вы можете вызвать его просто plugman.

Создание проекта Cordova

Прежде чем вы сможете использовать Plugman, необходимо создать проект Cordova. Вы можете сделать это с помощью интерфейса командной строки или с помощью скриптов оболочки более низкого уровня. Инструкции по использованию скриптов оболочки для создания вашего проекта находятся в различных руководствах "Инструменты командной строки", перечисленных на странице руководств по платформам.

Добавление плагина

После установки Plugman и создания проекта Cordova вы можете начать добавление плагинов к платформе с помощью:

$ plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]

Используя минимальные параметры, эта команда устанавливает плагин в проект cordova. Вы должны указать платформу и расположение проекта cordova для этой платформы. Вы также должны указать плагин, при этом разные формы параметра --plugin:

• name: Имя каталога, где находятся содержимое плагина. Это должен быть существующий каталог в --plugins_dir пути (см. ниже больше информации) или плагин в реестре Cordova.
• url: URL, начинающийся с https:// или git://, указывающий на допустимый репозиторий git, который можно клонировать и содержит файл plugin.xml. Содержимое этого репозитория будет скопировано в --plugins_dir.
• path: Путь к каталогу, содержащему допустимый плагин, который включает файл plugin.xml. Содержимое этого пути будет скопировано в --plugins_dir.

Другие параметры:

• --plugins_dir по умолчанию <project>/cordova/plugins, но может быть любым каталогом, содержащим подкаталог для каждого полученного плагина.
• --www по умолчанию расположение папки www проекта, но может быть любым каталогом, который будет использоваться в качестве веб-активов приложения cordova проекта.
• --variable позволяет указать определенные переменные во время установки, необходимые для определенных плагинов, требующих API-ключей или других пользовательских параметров. Более подробную информацию см. в спецификации плагина.

Удаление плагина

Чтобы удалить плагин, просто передайте команду uninstall и укажите идентификатор плагина.

$ plugman uninstall --platform <ios|android|blackberry10|wp8> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]

Команды справки

Plugman имеет глобальную команду справки, которая может помочь вам, если вы застряли или у вас возникли проблемы. Она отобразит список всех доступных команд Plugman и их синтаксис:

plugman -help
plugman  # same as above

ПРИМЕЧАНИЕ: plugman -help может отобразить некоторые дополнительные команды, связанные с реестром. Эти команды предназначены для разработчиков плагинов и могут не быть реализованы в сторонних реестрах плагинов.

Вы также можете добавить флаг --debug|-d к любой команде Plugman, чтобы запустить эту команду в режиме подробного отображения, который отобразит все внутренние сообщения отладки по мере их появления и может помочь вам отследить проблемы, такие как недостающие файлы.

# Adding Android battery-status plugin to "myProject":
plugman -d --platform android --project myProject --plugin cordova-plugin-battery-status

Наконец, вы можете использовать флаг --version|-v для просмотра версии Plugman, которую вы используете.

plugman -v

Действия с реестром

Есть ряд команд plugman, которые могут быть использованы для взаимодействия с реестром плагинов. Обратите внимание, что эти команды реестра специфичны для реестра плагинов plugins.cordova.io и могут не быть реализованы сторонними реестрами плагинов.

Поиск плагина

Вы можете использовать Plugman для поиска в реестре плагинов идентификаторов плагинов, которые соответствуют данному списку слов, разделенных пробелами.

plugman search <plugin keywords>

Изменение реестра плагинов

Вы можете получить или установить URL текущего реестра плагинов, используемого plugman. Обычно вы должны оставлять его установленным на http://registry.cordova.io, если не хотите использовать сторонний реестр плагинов.

plugman config set registry <url-to-registry>
plugman config get registry

Получение информации о плагине

Вы можете получить информацию о любом конкретном плагине, хранящемся в репозитории плагинов с помощью:

plugman info <id>

Это позволит связаться с реестром плагинов и извлечь такую информацию, как номер версии плагина.

Установка основных плагинов

Примеры ниже показывают, как добавить плагины по мере необходимости, чтобы любые Cordova API, которые вы используете в своем проекте, по-прежнему работали после обновления до версии 3.0. Для каждой команды необходимо выбрать целевую платформу и указать директорию проекта платформы.

• cordova-plugin-battery-status

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-battery-status
  

• cordova-plugin-camera

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-camera
  

• cordova-plugin-console

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-console
  

• cordova-plugin-contacts

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-contacts
  

• cordova-plugin-device

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device
  

• cordova-plugin-device-motion (акселерометр)

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device-motion
  

• cordova-plugin-device-orientation (компас)

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device-orientation
  

• cordova-plugin-dialogs

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-dialogs
  

• cordova-plugin-file

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-file
  

• cordova-plugin-file-transfer

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-file-transfer
  

• cordova-plugin-geolocation

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-geolocation
  

• cordova-plugin-globalization

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-globalization
  

• cordova-plugin-inappbrowser

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-inappbrowser
  

• cordova-plugin-media

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-media
  

• cordova-plugin-media-capture

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-media-capture
  

• cordova-plugin-network-information

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-network-information
  

• cordova-plugin-splashscreen

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-splashscreen
  

• cordova-plugin-vibration

  plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-vibration