Correct Syntax For Pulling Plugin from GitHub Via NPM

  • 2
  • Idea
  • Updated 5 years ago
I have the following configuration:

<gap:plugin name="cordova-plugin-canvas2image" source="npm" spec="github:nicolasgrolleau/Canvas2ImagePlugin" />

Trying to pull nicolas' fork:

https://github.com/nicolasgrolleau/Ca...

but receive the following error in PGB:

Failed to fetch plugin cordova-plugin-canvas2image@github:nicolasgrolleau/Canvas2ImagePlugin via registry.

What is the correct syntax within the config.xml file in order to pull plugins from GitHub? I believe this is possible based on the following blog:

"instead of a version attribute the Cordova cli uses spec. spec is used both as a way to specify version (for npm) and also to specify the source repository of the plugin (eg. github:mygithubuser/myproject). Basically it allows anything that npm allows as part of it’s install command."

http://phonegap.com/blog/2015/11/19/c...

I've tried removing the "gap:" namespace, but to no avail – same error reported.

Any thoughts on how to implement this awesome bleeding edge functionality?

--------

.:edit:. Changed this to an idea based on @BrettRudd's Tweet:

"@jasoncdivis pulling plugins from GitHub is not supported. it's on our roadmap. but would be public repos only."
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes

Posted 5 years ago

  • 2
Photo of JesseMonroy650 (Volunteer)

JesseMonroy650 (Volunteer), Champion

  • 3325 Posts
  • 122 Reply Likes
@Jason,
currently the NPM syntax is *supposed* to be supported, but I suspect as the documentation alludes to, you can only get the Version.


<gap:plugin name="cordova-plugin-canvas2image" source="npm" spec="0.7.0" />


The BLOG STATES, Basically it allows anything that npm allows as part of it’s install command..

In your case, the npm points to this, so yours might be:


<gap:plugin name="cordova-plugin-canvas2image" source="npm" spec="github:devgeeks/Canvas2ImagePlugin" />


Please let us know what works for you, or not.

Best of Luck
Jesse
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes
Turning my edit into a reply to make it obvious:

Changed this to an idea based on @BrettRudd's Tweet:

"@jasoncdivis pulling plugins from GitHub is not supported. it's on our roadmap. but would be public repos only."

Thanks for validating that what I read in the blog wasn't totally off, even though it turns out to be an incorrect interpretation.
Photo of JesseMonroy650 (Volunteer)

JesseMonroy650 (Volunteer), Champion

  • 3325 Posts
  • 122 Reply Likes
@Jason, the blog should have been clear and not alluded to a more general use. Then again, there is always something to complain about.

Thanks for sharing. I'll make note of the correct interpretation.
Jesse
Photo of Brett

Brett, OFFICIAL REP

  • 547 Posts
  • 54 Reply Likes
this will drop first week of December.
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes
Hey Brett, I haven't seen a blog post drop about this functionality being introduced, but has it been released?
Photo of JesseMonroy650 (Volunteer)

JesseMonroy650 (Volunteer), Champion

  • 3325 Posts
  • 122 Reply Likes
@Jason, It appears there may be a wait. Please read: Where is the support crew?
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes
No problem. I look forward to hearing from Brett and crew when they are back.
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes
Bump
Photo of JesseMonroy650 (Volunteer)

JesseMonroy650 (Volunteer), Champion

  • 3325 Posts
  • 122 Reply Likes
@Jason, support is a bit backed up. If it is not up tomorrow, we can send them a tweet on this. https://twitter.com/phonegapbuild
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes
Thank you for the guidance. I'll reach out on Twitter if need be.
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes
Jesse, any help here? I've tapped @Brett on Twitter. What other channels are available? Thanks for your help.
Photo of Petra V.

Petra V., Champion

  • 7794 Posts
  • 1391 Reply Likes
You shouldn't hold your breath, Jason.
- the Support Crew has vanished almost 2 months ago
- the latest PGB Blog article is from Nov.19, '15
- changes that were announced for December were never heard of, anymore

Doesn't look very promising.
Photo of JesseMonroy650 (Volunteer)

JesseMonroy650 (Volunteer), Champion

  • 3325 Posts
  • 122 Reply Likes
@Petra,
the support crew is back, but not answering the forum. It someone has an urgent need, send a tweet. I know they are overloaded.
Jesse
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes
From Brett via the Twittersphere: working on it. will blog about it. more rewriting than first thought. no date yet but this month for sure. https://t.co/w6wiZGx9Rs
Photo of Jason

Jason

  • 10 Posts
  • 0 Reply Likes
That's amazing! Thanks Brett, and the PGB team!