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

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

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

• Если вы используете ориентированный на платформу рабочий процесс, вы используете интерфейс командной строки Plugman более низкого уровня, отдельно для каждой целевой платформы. 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 install --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>

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

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

Примеры ниже показывают, как добавлять плагины по мере необходимости, чтобы любые API Cordova, используемые в вашем проекте, по-прежнему работали после обновления до версии 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 (accelerometer)

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

• cordova-plugin-device-orientation (compass)

  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