Plugins verwalten mithilfe Plugman
Ab Version 3.0 ff. Cordova implementiert alle Gerät APIs als Plugins und lässt sie standardmäßig deaktiviert. Es unterstützt auch zwei Möglichkeiten zum Hinzufügen und Entfernen von Plugins. Die erste ist mithilfe der cordova
CLI in der Command-Line Interface beschrieben. Die zweite ist die Verwendung einer Low-Level- Plugman -Befehlszeilenschnittstelle ("Native Plattform Dev" Workflow.) Der Hauptunterschied zwischen diesen zwei Entwicklungswege ist, dass Plugman Plugins nur an einer Plattform zu einem Zeitpunkt hinzufügen kann, während die CLI Plugins alle Plattformen hinzufügt, die Sie abzielen. Aus diesem Grund ist es sinnvoller, Plugman zu verwenden, wenn Sie eng mit einer einzigen Plattform, daher der "Native Plattform Dev" Name des Workflows arbeiten.
Weitere Informationen über Plugman vor allem, wenn Sie verbrauchen Plugman als Knoten Modul oder auf dem Plugman-Code hacking interessiert sind, finden Sie in der README-Datei im repository.
Installation von Plugman
Um Plugman zu installieren, müssen Sie die Knoten , die auf Ihrem Computer installiert haben. Dann die folgenden ausführen Befehl an einer beliebigen Stelle in Ihrer Umgebung Plugman weltweit so installieren, dass es von einem beliebigen Verzeichnis auf Ihrem Rechner verfügbar ist:
$ npm install -g plugman
Haben außerdem muss git
auf Ihre PATH
um Plugins direkt aus entfernten Git URLs zu installieren zu können.
Tipp: Wenn Sie feststellen, dass nach der Installation von Plugman mit Npm Sie noch nicht in der Lage sind, alle plugman
Befehle, stellen Sie sicher, dass Sie hinzugefügt haben die /npm/
Verzeichnis in IhrerPATH
.
Hinweis: Sie können diesen Schritt überspringen, wenn Sie nicht, um Ihre globalen Npm-Namespace verschmutzen durch die Installation von Plugman weltweit möchten. Wenn dies ist der Fall, wenn Sie ein Cordova-Projekt mit der Shell-Werkzeugen erstellen, gibt es ein node_modules
Verzeichnis innerhalb des Projekts die Plugman enthält. Da du nicht instally Global hast, Sie müssen Knoten für jeden Plugman-Befehl aufrufen, z. B. node ./node_modules/plugman/main.js -version
. Der Rest dieser Anleitung wird angenommen, dass Sie Plugman weltweit installiert haben was bedeutet, dass Sie es mit nur aufrufen könnenplugman
.
Erstellen Sie ein Projekt von Cordova
Bevor Sie Plugman verwenden können, müssen Sie ein Cordova-Projekt erstellen. Sie können dies tun, mit der Befehlszeilen-Schnittstelle oder mit der unteren Ebene Shell-Skripte. Anweisungen zur Verwendung der Shell-Skripte erstellen Sie Ihr Projekt befinden sich in den verschiedenen "Command-Line Tools"-Führern, die auf der Plattform Guides-Seite aufgelistet.
Eine Plugin hinzufügen
Sobald Sie Plugman installiert haben und ein Cordova-Projekt erstellt haben, können Sie beginnen, die Plattform mit Plugins hinzufügen:
$ 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> ...]]
Mit minimalen Parametern, wird dieser Befehl eine Plugin in einem Cordova-Projekt installiert. Sie müssen eine Plattform und Cordova Projektspeicherort für diese Plattform angeben. Sie müssen auch eine Plugin, mit den verschiedenen angeben --plugin
Parameter bildet sein:
-
name
: Der Verzeichnisname, wo die Plugin-Inhalte vorhanden sind. Dies muss ein vorhandenes Verzeichnis unter den--plugins_dir
Pfad (für mehr Info siehe unten) oder ein Plugin in der Cordova-Registrierung. -
url
: Eine URL mit https:// oder Git: / / zeigen zu einem gültigen Git-Repository, das geklont werden und enthält eineplugin.xml
Datei. Kopiert den Inhalt dieses Archivs würden in der--plugins_dir
. -
path
: Ein Pfad zu einem Verzeichnis, die eine gültige Plugin umfasst eineplugin.xml
Datei. Dieser Pfad Inhalt kopiert werden, in der--plugins_dir
.
Weitere Parameter:
-
--plugins_dir
standardmaessig<project>/cordova/plugins
, aber kann jedes Verzeichnis ein Unterverzeichnis für jeden abgerufenen Plugin. -
--www
der Standardwert ist des Projektswww
Ordnerspeicherort, kann jedoch jedes Verzeichnis, das als Cordova Projekt Anwendung Web Vermögenswerte verwendet werden. -
--variable
ermöglicht es, bestimmte Variablen zum Zeitpunkt der Installation notwendig für bestimmte Plugins, die die API-Schlüssel oder andere benutzerdefinierte, benutzerdefinierte Parameter angeben. Finden Sie die Plugin-Spezifikation für weitere Informationen.
Eine Plugin zu entfernen
Um ein Plugin zu deinstallieren, übergeben Sie einfach die --uninstall
-flag und bieten die Plugin-ID.
$ plugman --uninstall --platform <ios|amazon-fireos|android|blackberry10|wp7|wp8> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]
Hilfebefehle
Plugman verfügt über einen global Help-Befehl, der Ihnen helfen können, wenn Sie stecken bleiben oder Probleme auftreten. Es erscheint eine Liste aller verfügbaren Plugman-Befehle und deren Syntax:
plugman -help
plugman # same as above
Hinweis: plugman -help
können einige zusätzliche Registrierung bezogenen Befehle zeigen. Diese Befehle sind für Plugin-Entwickler und können nicht auf Drittanbieter-Plugin-Register implementiert werden.
Sie können auch Anhängen der --debug|-d
Flagge auf jeden Plugman-Befehl diesen Befehl im ausführlichen Modus ausgeführt, die internen Debuggen-Meldungen angezeigt werden, da sie ausgegeben werden und Ihnen helfen können, ausfindig zu machen Probleme wie fehlende Dateien.
# Adding Android battery-status plugin to "myProject":
plugman -d --platform android --project myProject --plugin org.apache.cordova.battery-status
Schließlich können Sie die --version|-v
Flagge zu sehen, welche Plugman-Version Sie verwenden.
plugman -v
Registrierungsaktionen
Es gibt eine Reihe von Plugman-Befehlen, die für die Interaktion mit der Plugin-Registrierungverwendet werden kann. Bitte beachten Sie, dass diese Registrierung-Befehle beziehen sich auf die plugins.cordova.io -Plugin-Registry und nicht von Drittanbieter-Plugin-Register implementiert werden können.
Auf der Suche nach einem Plugin
Plugman können Sie suchen der Plugin Registrierung für Plugin-Id, die die angegebenen Leerzeichen getrennte Liste von Schlüsselwörtern entsprechen.
plugman search <plugin keywords>
Ändern der Plugin-Registrierung
Sie können abrufen oder Festlegen der URL der aktuellen Plugin-registry, die Plugman benutzt. In der Regel lassen Sie dies auf http://registry.cordova.io festgelegt wird, sofern Sie eine Drittanbieter-Plugin-Registry verwenden möchten.
plugman config set registry <url-to-registry>
plugman config get registry
Plugin informieren
Hier erhalten Sie Informationen über alle spezifischen Plugin im Plugin Repository mit gespeichert:
plugman info <id>
Dies wird der Plugin Registrierung und Abruf Informationen wie das Plugin Versionsnummer kontaktieren.
Core-Plugins installieren
Die folgenden Beispiele veranschaulichen, Plugins hinzufügen, nach Bedarf, so dass Sie in Ihrem Projekt verwenden APIs Cordova noch funktionieren nach dem upgrade auf Version 3.0. Für jeden Befehl müssen Sie wählen die Zielplattform und die Plattform-Projektverzeichnis zu verweisen.
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