You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by Apache Wiki <wi...@apache.org> on 2013/08/01 01:10:39 UTC
[Cordova Wiki] Update of "PluginDiscovery" by AnisKadri
Dear Wiki user,
You have subscribed to a wiki page or wiki category on "Cordova Wiki" for change notification.
The "PluginDiscovery" page has been changed by AnisKadri:
https://wiki.apache.org/cordova/PluginDiscovery?action=diff&rev1=5&rev2=6
= Plugin Registry =
- We use [[https://github.com/isaacs/npmjs.org|npmjs.org]]. To set up your own registry. Follow the steps on there. Make sure to set ''secure_rewrites'' to false in your CouchDB config (You can use ''futon'' for that).
+ We use [[https://github.com/isaacs/npmjs.org|npmjs.org]]. To set up your own registry. Follow the steps on there. Make sure to set '''''secure_rewrites''''' to false in your CouchDB config (You can use ''futon'' for that).
= plugin.xml tags =
- To publish a Cordova plugin. One has to specify a couple of things. As per npm, <name> and ''version'' attribute are required. Everything else is optional. <name> has to follow npm's rules (no spaces).
+ To publish a Cordova plugin. One has to specify a couple of things. As per npm, '''''id''''' and '''''version''''' ''<plugin>'' attributes are required. Everything else is optional. <name> is a human readable name and does not have to follow npm's rules (no spaces).
- There are new XML tags that are pretty self explanatory: <author>, <description>, <license>, <keywords> (comma separated keywords). They help with search and discovery.
+ There are new XML tags that are pretty self explanatory: ''<author>'', ''<description>'', ''<license>'', ''<keywords>'' (comma separated keywords). They help with search and discovery.
-
- = plugman-registry =
-
- This is a module used by plugman that relies on npm to talk to the registry. It also creates a package.json based on Cordova's plugin.xml which is required by npm. It stores its configuration and cache in a folder named $HOME/.plugman so that it doesn't interfere with npm's configuration. It implements and maps the following actions:
-
- * adduser: adds a user to the registry
- * publish: creates a package.json based on the plugin.xml and publishes it to the registry
- * unpublish: unpublishes package from registry
- * search: searches a plugin given some keywords
- * fetch: fetches a plugin from cache (if present) or from registry
= plugman =
+ Plugman creates a package.json based on Cordova's plugin.xml which is required by npm. It stores its configuration, log file and cache in a folder named ''.plugman'' in the user's directory so that it doesn't interfere with npm's own configuration. It implements and maps the following actions:
+
+ * '''adduser''': adds a user to the registry
+ * '''publish''': creates a package.json based on the plugin.xml and publishes it to the registry
+ * '''unpublish''': unpublishes package from registry
+ * '''search''': searches a plugin given some keywords
+ * '''fetch''': fetches a plugin from cache (if present) or from registry
+
+ = plugman =
+
- plugman can be pointed at a registry in config.js
+ plugman can be pointed at any registry by running
+
+ * {{{$ plugman config set registry http://localhost:5984/registry/_design/app/_rewrite # useful for local debugging }}}
plugman has new commands to handle ''adduser'', ''publish'', ''unpublish'', ''search''. One can install a plugin from registry by specifying the plugin_name if that plugin is not already in the Cordova project's plugins directory.
== Examples ==
* {{{$ plugman --plugin plugin_name --project /path/to/project --platform ios}}}
- * {{{$ plugman --adduser}}}
+ * {{{$ plugman adduser}}}
- * {{{$ plugman --publish --plugin path/to/plugin}}}
+ * {{{$ plugman publish path/to/plugin}}}
- * {{{$ plugman --unpublish --plugin plugin[@version]}}}
+ * {{{$ plugman unpublish plugin[@version]}}}
- * {{{$ plugman --search --plugin keyword1,keyword2]}}}
+ * {{{$ plugman search keyword1[,keyword2,...,keywordn]}}}
= Missing =