Cordova plugins? Put them in your own repo
[edited: removed reference to pluginstall which is PhoneGap Build centric, to Plugman which is based on pluginstall but is Cordova centric, and more frequently updated]
Right now, there is one repo that contains the majority of plugins available for Cordova at: http://github.com/phonegap/phonegap-plugins
We don’t want to “clutter” this repo with code anymore. Authors should maintain the code in their own repos and just put a pointer in a README.md in phonegap-plugins (perhaps in the same hierarchy). What this enables is, when the time comes – package-able plugins that can be installed using plugman that are built according to the Cordova Plugin spec. This also helps for the future whenever we decide to have a npm-like registry for Cordova plugins.
Having the plugins in separate repos also enables less clutter for pull requests and bugs, with it all being in one repo it is hard to get attention for an issue since that can be buried. I know that I like to fix some of my plugins, but it’s hard with it all lumped in there with other unrelated plugin issues.
As a reminder, this is how to write a Plugin:
http://docs.cordova.io/en/edge/guide_plugin-development_index.md.html#Plugin%20Development%20Guide
For examples of plugins that conform to the Cordova Plugin spec and are plugman-able:
- https://github.com/phonegap-build/BarcodeScanner
- https://github.com/phonegap-build/ChildBrowser
- https://github.com/phonegap-build/GAPlugin
- https://github.com/shazron/TestFlightPlugin
- https://github.com/shazron/KeychainPlugin
I’ve already moved out the plugins that I started implementation on (iAdPlugin, KeychainPlugin, PayPalPlugin, TorchPlugin, TestFlightPlugin). I suggest that you do the same.
[...] Cordova plugins? Put them in your own repo [...]
Cordova plugins? Put them in your own repo | SDK News
November 8, 2012 at 7:59 am
Just moved my plugins into separate repositories.
Here’s how to prune all unnecessary history (change the command according to your plugin’s path):
git filter-branch --subdirectory-filter iOS/TabBar -- --allAndiDog
November 8, 2012 at 10:44 am
Started moving LocalNotifications stuff to a separate repo – https://github.com/olore/LocalNotifications
Brian Olore™ (@olore)
December 6, 2012 at 12:28 am
With this new model, should the repo in which the plugin resides have to be a GitHub repo or can it be a ‘regular’ git repo on a private server ?
bijan
December 17, 2012 at 8:29 pm
Any publicly accessible git repo would do, although discovery (and interaction for bugs) would be hard if it’s not on some site like Github or Bitbucket
shazron
December 21, 2012 at 12:05 am
I have put my Phonegap plugin in my own repo but how do I “just put a pointer in a README.md in phonegap-plugins (perhaps in the same hierarchy)”?
Remco Beugels
January 3, 2013 at 4:32 pm
Create a folder in the Android folder in the repo, add a README.md with your details, then commit it to your forked Github repo. Then send a pull request.
shazron
January 3, 2013 at 8:52 pm
I’ve updated the post to refer to Plugman instead of Pluginstall. Use Plugman in the future since it is being actively developed.
shazron
January 5, 2013 at 6:00 pm
Wouldn’t it make more sense to just set up a wiki instead of having to submit pull requests?
bar
January 13, 2013 at 11:49 pm
Sure. The main reason is for discovery — and the repo is just a temporary solution (and it is the most well known) until we figure out a permanent listing.
shazron
January 14, 2013 at 10:05 pm