Aide de Plugman pour gérer les Plugins

Depuis la version 3.0, Cordova implémente toutes les API de périphérique API comme des plugins et les laisse désactivé par défaut. Il prend également en charge deux méthodes différentes pour ajouter et supprimer des plugins. La première consiste à utiliser le cordova CLI décrit dans l'Interface de ligne de commande. La seconde consiste à utiliser une interface de ligne de commande de Plugman de niveau inférieur (flux de travail "plate-forme Native dev"). La principale différence entre ces voies de deux développement est que Plugman peut uniquement ajouter des plugins à une plate-forme à la fois, alors que le CLI va ajouter des plugins pour toutes les plates-formes que vous ciblez. Pour cette raison, il est plus logique d'utiliser Plugman lorsque vous travaillez étroitement avec une plate-forme unique, d'où le nom de "Natif plate-forme Dev" du flux de travail.

Pour plus d'informations sur Plugman, surtout si vous êtes intéressé à consommer Plugman comme un module de nœud ou de piratage sur le code de Plugman, consultez le fichier README dans son référentiel.

Installation de Plugman

Pour installer plugman, vous devez avoir le noeud installé sur votre machine. Vous pouvez exécuter ce qui suit, puis commande de n'importe où dans votre environnement pour installer plugman dans le monde, afin qu'il soit disponible de n'importe quel répertoire sur votre ordinateur :

$ npm install -g plugman

Vous devez également avoir git sur votre PATH pour pouvoir installer des plugins directement à partir d'URL distant git.

Astuce : Si vous trouvez qu'après avoir installé le plugman avec npm, vous êtes toujours incapable d'exécuter un plugman commandes, assurez-vous que vous avez ajouté le /npm/ répertoire dans votrePATH.

Remarque : Vous pouvez ignorer cette étape si vous ne souhaitez pas polluer votre espace de noms global NGP en installant des Plugman dans le monde. Si c'est le cas, alors lorsque vous créez un projet de Cordoue avec les outils de la coquille, il y aura un node_modules répertoire à l'intérieur de votre projet qui contient Plugman. Puisque vous n'avez pas Morphix dans le monde, vous devrez appeler le nœud pour chaque commande de Plugman, par exemple node ./node_modules/plugman/main.js -version . Le reste du présent guide suppose que vous avez installé Plugman dans le monde, ce qui signifie que vous pouvez l'appeler avec justeplugman.

Créez un projet de Cordova

Avant de pouvoir utiliser Plugman, vous devez créer un projet de Cordova. Vous pouvez le faire avec l'Interface de ligne de commande ou avec les scripts de shell de niveau inférieurs. Instructions pour l'utilisation des scripts shell pour créer votre projet sont situées dans les différents guides « Command-line Tools » figurant sur la page des Guides de la plate-forme.

Ajout d'un Plugin

Une fois que vous avez installé Plugman et que vous avez créé un projet de Cordova, vous pouvez commencer à ajouter des plugins à la plate-forme avec :

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

À l'aide de paramètres minimum, cette commande installe un plugin dans un projet de cordova. Vous devez spécifier un emplacement de projet de plate-forme et cordova pour cette plateforme. Vous devez également spécifier un plugin, avec les différentes --plugin paramètre forme étant :

  • name: Le nom du répertoire où le contenu du plugin existe. Il doit s'agir d'un répertoire existant en vertu de la --plugins_dir chemin d'accès (voir ci-dessous pour plus d'informations) ou un plugin dans le registre de Cordova.
  • url: Une URL commençant par https:// ou git: / /, pointant vers un dépôt git valide qui peut être clonée et contient un plugin.xml fichier. Le contenu de ce dépôt devrait être copié dans le--plugins_dir.
  • path: Un chemin vers un répertoire contenant un plugin valide qui comprend un plugin.xml fichier. Contenu de ce tracé sera copié dans le--plugins_dir.

Autres paramètres :

  • --plugins_dirvaleur par défaut est <project>/cordova/plugins , mais peut être n'importe quel répertoire contenant un sous-répertoire pour chaque extrait plugin.
  • --wwwpar défaut, du projet www emplacement du dossier, mais peut être n'importe quel répertoire qui doit être utilisé comme patrimoine de cordova projet applicatif web.
  • --variablepermet de spécifier certaines variables au moment de l'installation, nécessaire pour certains plugins, exigeant que les clés de l'API ou d'autres paramètres personnalisés, définis par l'utilisateur. Veuillez consulter la spécification de plugin pour plus d'informations.

Supprimer un Plugin

Pour désinstaller un plugin, vous transmettez simplement le --uninstall d'un drapeau et fournir l'ID du plugin.

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

Aide commandes

Plugman dispose d'une commande globale d'aide qui peut-être vous aider si vous êtes coincé ou rencontrez des problèmes. Il affiche une liste de toutes les commandes disponibles de Plugman et de leur syntaxe :

plugman -help
plugman  # same as above

Remarque: plugman -help peut montrer quelques commandes supplémentaires associés au registre. Ces commandes sont pour les développeurs de plugins et ne peuvent pas être implémentées sur les registres de plugin tiers.

Vous pouvez également ajouter le --debug|-d drapeau à n'importe quelle commande de Plugman pour exécuter cette commande en mode détaillé, qui permet d'afficher des messages de débogage internes car ils sont émis et peuvent vous aider à traquer les problèmes tels que des fichiers manquants.

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

Enfin, vous pouvez utiliser le --version|-v drapeau pour voir quelle version de Plugman que vous utilisez.

plugman -v

Registre des Actions

Il y a un certain nombre de commandes plugman qui peut être utilisé pour interagir avec le Plugin registry. Veuillez noter que ces commandes de Registre sont au plugin plugins.cordova.io Registre et ne peuvent pas être exécutées en plugin tiers registres.

La recherche d'un Plugin

Vous pouvez utiliser Plugman pour rechercher le Registre Plugin plugin ID qui correspondent à la liste séparés par un espace donné de mots clés.

plugman search <plugin keywords>

Changer le Registre du Plugin

Vous pouvez obtenir ou définir l'URL de l'actuel Registre plugin qui utilise plugman. Généralement, vous devriez laisser ce jeu à http://registry.cordova.io, à moins que vous voulez utiliser un registre de plugin tiers.

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

Obtenir des informations du Plugin

Vous pouvez obtenir des informations sur n'importe quel plugin spécifique stocké dans le référentiel de plugin avec :

plugman info <id>

Cela prendra contact avec le plugin Registre et l'extraction des informations comme numéro de version du plugin.

Installation des Plugins du Core

Les exemples ci-dessous montrent comment ajouter des plugins nécessaires afin que toute APIs Cordova vous utilisez dans votre projet fonctionne toujours après que vous mettez à niveau vers la version 3.0. Pour chaque commande, vous devez sélectionner la plate-forme cible et le répertoire de projet de la plate-forme de référence.

  • cordova-plugin-battery-status

    plugman --platform --project --plugin org.apache.cordova.battery-status

  • cordova-plugin-camera plugman --platform --project --plugin org.apache.cordova.camera

  • cordova-plugin-console plugman --platform --project --plugin org.apache.cordova.console

  • cordova-plugin-contacts plugman --platform --project --plugin org.apache.cordova.contacts

  • cordova-plugin-device plugman --platform --project --plugin org.apache.cordova.device

  • cordova-plugin-device-motion (accelerometer) plugman --platform --project --plugin org.apache.cordova.device-motion

  • cordova-plugin-device-orientation (compass) plugman --platform --project --plugin org.apache.cordova.device-orientation

  • cordova-plugin-dialogs plugman --platform --project --plugin org.apache.cordova.dialogs

  • cordova-plugin-file plugman --platform --project --plugin org.apache.cordova.file

  • cordova-plugin-file-transfer plugman --platform --project --plugin org.apache.cordova.file-transfer

  • cordova-plugin-geolocation plugman --platform --project --plugin org.apache.cordova.geolocation

  • cordova-plugin-globalization plugman --platform --project --plugin org.apache.cordova.globalization

  • cordova-plugin-inappbrowser plugman --platform --project --plugin org.apache.cordova.inappbrowser

  • cordova-plugin-media plugman --platform --project --plugin org.apache.cordova.media

  • cordova-plugin-media-capture plugman --platform --project --plugin org.apache.cordova.media-capture

  • cordova-plugin-network-information plugman --platform --project --plugin org.apache.cordova.network-information

  • cordova-plugin-splashscreen plugman --platform --project --plugin org.apache.cordova.splashscreen

  • cordova-plugin-vibration plugman --platform --project --plugin org.apache.cordova.vibration