Использование 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> --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> --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> --project <directory> --plugin cordova-plugin-battery-status
  

• cordova-plugin-camera

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

• cordova-plugin-console

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

• cordova-plugin-contacts

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

• cordova-plugin-device

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

• cordova-plugin-device-motion (accelerometer)

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

• cordova-plugin-device-orientation (compass)

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

• cordova-plugin-dialogs

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

• cordova-plugin-file

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

• cordova-plugin-file-transfer

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

• cordova-plugin-geolocation

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

• cordova-plugin-globalization

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

• cordova-plugin-inappbrowser

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

• cordova-plugin-media

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

• cordova-plugin-media-capture

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

• cordova-plugin-network-information

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

• cordova-plugin-splashscreen

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

• cordova-plugin-vibration

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