incubator-callback-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Mike Reinstein <reinstein.m...@gmail.com>
Subject Re: plugin tooling/specification
Date Sun, 09 Sep 2012 15:02:11 GMT
Hey folks,

Hope you all had a nice weekend.  I have a preliminary draft ready that
merges cordova-client and command line tooling design into 1 document:

https://github.com/mreinstein/incubator-cordova-labs/tree/cordova-client

Any feedback would be greatly appreciated. Thanks!

-Mike

On Fri, Sep 7, 2012 at 10:01 PM, Anis KADRI <anis.kadri@gmail.com> wrote:

> Hi Mike,
>
> pluginstall-with-git support is just an experiment that I did a while back
> (it takes git URLs as well as local paths). I suggest you base your work on
> alunny's pluginstall until/if those changes get merged.
>
> Cheers
>
> Anis
>
> On Fri, Sep 7, 2012 at 6:14 PM, Mike Reinstein <reinstein.mike@gmail.com
> >wrote:
>
> > I see 2 repositories for pluginstall:
> >
> >
> >
> https://github.com/apache/incubator-cordova-labs/tree/pluginstall-with-git-support
> >
> > and Andrew's:
> > https://github.com/alunny/pluginstall
> >
> > When consolidating the pluginstall and plugin format docs I forked
> Andrew's
> > repo. Should I instead have used the pluginstall-with-git-support repo as
> > my base?
> >
> > -Mike
> >
> > On Fri, Sep 7, 2012 at 8:01 PM, Mike Reinstein <reinstein.mike@gmail.com
> > >wrote:
> >
> > > My username is nekoflux.
> > >
> > >
> > >
> > > On Fri, Sep 7, 2012 at 7:53 PM, Filip Maj <fil@adobe.com> wrote:
> > >
> > >> JIRA is separate, we can assign issues to you (if you so wish).
> > >>
> > >> On 9/7/12 4:51 PM, "Shazron" <shazron@gmail.com> wrote:
> > >>
> > >> >Registration is open - let us know what your user account is once you
> > >> >do that, for assigning issues to yourself you need us to add you to
a
> > >> >contributors group.
> > >> >
> > >> >On Fri, Sep 7, 2012 at 4:44 PM, Mike Reinstein <
> > reinstein.mike@gmail.com
> > >> >
> > >> >wrote:
> > >> >> Okay, will do. Any feedback on the other comments? I'll proceed
> with
> > >> >> merging the cordova-client and command line tooling spec next.
I
> > >> >>suppose it
> > >> >> probably makes sense for me to start working out of JIRA so these
> > tasks
> > >> >>can
> > >> >> be tracked. Is registration open or do I need to get permission
> from
> > an
> > >> >> admin for an account?
> > >> >>
> > >> >>
> > >> >>
> > >> >> On Fri, Sep 7, 2012 at 2:37 PM, Filip Maj <fil@adobe.com>
wrote:
> > >> >>
> > >> >>> Sorry for the late reply, this looks awesome!
> > >> >>>
> > >> >>> The one modification I would do is remove "www" as a platform
(you
> > >> >>>have a
> > >> >>> comment in there about that too).
> > >> >>>
> > >> >>> On 9/5/12 7:12 PM, "Mike Reinstein" <reinstein.mike@gmail.com>
> > wrote:
> > >> >>>
> > >> >>> >> eventually we will move pluginstall into apache
> > >> >>> >Okay, I wasn't sure if that would happen, so I went with
the
> > slightly
> > >> >>>more
> > >> >>> >conservative assumption, that pluginstall might live separately
> > from
> > >> >>> >cordova-client. But I get the impression this is a left-over
> notion
> > >> >>>from
> > >> >>> >when Andrew first built pluginstall and it wasn't clear
then
> > whether
> > >> >>>or
> > >> >>> >not
> > >> >>> >it would take hold.
> > >> >>> >
> > >> >>> >I've got an initial version of the merged documentation
for the
> > >> >>> >pluginstall
> > >> >>> >command line tool, and the specification doc. It's here
> > >> >>> >https://github.com/mreinstein/pluginstall
> > >> >>> >
> > >> >>> >I've also added some comments on possible changes. Overall
the
> doc
> > is
> > >> >>> >pretty tight, so it's largely unchanged. Would really
appreciate
> > >> >>> >constructive feedback on this. If it looks right I'll
send a pull
> > >> >>>request
> > >> >>> >to alunny, and then proceed with merging cordova-client
design
> doc
> > >> >>>into
> > >> >>> >the
> > >> >>> >README on github.
> > >> >>> >
> > >> >>> >-Mike
> > >> >>> >
> > >> >>> >On Tue, Sep 4, 2012 at 1:47 PM, Filip Maj <fil@adobe.com>
wrote:
> > >> >>> >
> > >> >>> >> +1 !
> > >> >>> >>
> > >> >>> >> (I THINK) eventually we will move pluginstall into
apache
> > (assuming
> > >> >>>the
> > >> >>> >> authors are cool with that) so it will go 2 docs
-> 1 doc.
> > >> >>> >>
> > >> >>> >> On 9/3/12 1:49 PM, "Brian LeRoux" <b@brian.io>
wrote:
> > >> >>> >>
> > >> >>> >> >love it
> > >> >>> >> >
> > >> >>> >> >On Sat, Sep 1, 2012 at 7:13 AM, Mike Reinstein
> > >> >>> >><reinstein.mike@gmail.com>
> > >> >>> >> >wrote:
> > >> >>> >> >> Ah ok, thanks for the clarification. I've
had a chance to
> > review
> > >> >>>the
> > >> >>> >> >>docs
> > >> >>> >> >> more carefully. I'm really impressed with
how well written
> > they
> > >> >>>are.
> > >> >>> >> >>What I
> > >> >>> >> >> *think* makes the most sense is to consolidate
into fewer
> > >> >>>documents
> > >> >>> >>so
> > >> >>> >> >>that
> > >> >>> >> >> it's not necessary to look at so many seperate
places.
> Here's
> > >> >>>what I
> > >> >>> >> >> propose:
> > >> >>> >> >> * merge the cordova-plugin-spec into the
alunny/pluginstall
> > >> >>>README.md
> > >> >>> >> >> * merge the command line tooling design
doc into the
> > >> >>>cordova-client
> > >> >>> >> >> README.md
> > >> >>> >> >> * pull apart the cordova/PluginDesign wiki
page and merge
> > parts
> > >> >>>of it
> > >> >>> >> >>into
> > >> >>> >> >> the above 2 docs
> > >> >>> >> >>
> > >> >>> >> >> I think what this gets us is 2 docs instead
of 5, and it
> still
> > >> >>> >>maintains
> > >> >>> >> >> the nice loose coupling between alunny's
pluginstall utility
> > and
> > >> >>>the
> > >> >>> >> >>larger
> > >> >>> >> >> cordova-client. I'm assuming this separation
was the
> original
> > >> >>>intent,
> > >> >>> >> >> rather than having one monolithic tool.
> > >> >>> >> >>
> > >> >>> >> >> Would love feedback on this, I don't want
to waste time
> doing
> > it
> > >> >>>and
> > >> >>> >> >>find
> > >> >>> >> >> out this isn't appropriate. :)
> > >> >>> >> >>
> > >> >>> >> >>
> > >> >>> >> >> On Fri, Aug 31, 2012 at 3:35 PM, Filip Maj
<fil@adobe.com>
> > >> wrote:
> > >> >>> >> >>
> > >> >>> >> >>> Cordova-client depends on pluginstall.
Pluginstall does the
> > >> hard
> > >> >>> >>work
> > >> >>> >> >>>for
> > >> >>> >> >>> programmatic plugin installation, which
is just one of the
> > apis
> > >> >>> >> >>>available
> > >> >>> >> >>> in cordova-client. So, cordova=client
"shells out" to
> > >> >>>pluginstall.
> > >> >>> >> >>>
> > >> >>> >> >>> The client also handles app creation,
platform
> > >> >>>removal/addition, and
> > >> >>> >> >>> interpolating information from app's
config.xml into the
> > >> >>>necessary
> > >> >>> >> >>>spots
> > >> >>> >> >>> in each native project.
> > >> >>> >> >>>
> > >> >>> >> >>> On 8/31/12 12:32 PM, "Mike Reinstein"
<
> > >> reinstein.mike@gmail.com>
> > >> >>> >> wrote:
> > >> >>> >> >>>
> > >> >>> >> >>> >Hey Filip,
> > >> >>> >> >>> >
> > >> >>> >> >>> >One thing I"m curious about, whats
the difference between
> > >> >>> >> >>> >https://github.com/alunny/pluginstall
and
> > >> >>> >> >>>
> > >> >>> >>>
> > >> https://github.com/apache/incubator-cordova-labs/tree/cordova-client
> > >> >>> >> >>> >
> > >> >>> >> >>> >there seems to be some overlap there.
Is pluginstall a
> > subset
> > >> >>>of
> > >> >>> >> >>> >functionality just related to plugins
that has moved into
> > >> >>> >> >>>cordova-client
> > >> >>> >> >>> >or
> > >> >>> >> >>> >is it different?
> > >> >>> >> >>> >
> > >> >>> >> >>> >It seems like cordova-client is
the most mature codebase
> > that
> > >> >>> >> >>>incorporates
> > >> >>> >> >>> >a lot of ideas, so I'm just chasing
down code I'm finding
> to
> > >> >>>see if
> > >> >>> >> >>> >everythign is in cordova-client
or not. Said differently,
> is
> > >> it
> > >> >>> >>safe
> > >> >>> >> >>>to
> > >> >>> >> >>> >assume that just about all the worthwhile
code is in
> > >> >>> >>cordova-client?
> > >> >>> >> >>> >
> > >> >>> >> >>> >-Mike
> > >> >>> >> >>> >
> > >> >>> >> >>> >
> > >> >>> >> >>> >
> > >> >>> >> >>> >On Fri, Aug 31, 2012 at 3:01 PM,
Filip Maj <fil@adobe.com
> >
> > >> >>>wrote:
> > >> >>> >> >>> >
> > >> >>> >> >>> >> All looks good to me Mike.
> > >> >>> >> >>> >>
> > >> >>> >> >>> >> I think the "PluginDesign"
wiki article would be a great
> > >> >>>place to
> > >> >>> >> >>> >> summarize / revamp all this
info. Appreciate you
> tackling
> > >> >>>this!
> > >> >>> >> >>> >>
> > >> >>> >> >>> >> On 8/31/12 11:59 AM, "Mike
Reinstein"
> > >> >>><reinstein.mike@gmail.com>
> > >> >>> >> >>>wrote:
> > >> >>> >> >>> >>
> > >> >>> >> >>> >> >Hey Filip, Brian:
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >I think where I'd like
to start is on documentation. I
> > may
> > >> >>>be
> > >> >>> >>wrong
> > >> >>> >> >>> >>about
> > >> >>> >> >>> >> >this, but it seems like
there are bits and pieces of
> docs
> > >> in
> > >> >>> >> >>>various
> > >> >>> >> >>> >> >places, and some may be
stale or irrelevant. Maybe a
> good
> > >> >>>start
> > >> >>> >>is
> > >> >>> >> >>>for
> > >> >>> >> >>> >>me
> > >> >>> >> >>> >> >to find all these pieces,
consolidate into a "master"
> > >> >>>document,
> > >> >>> >>and
> > >> >>> >> >>> >>cull
> > >> >>> >> >>> >> >out the outdated bits?
As a start, here's my rephrasing
> > of
> > >> >>>the
> > >> >>> >> >>>various
> > >> >>> >> >>> >> >links, etc that you've
sent to me. Please take a look
> and
> > >> >>>let me
> > >> >>> >> >>>know
> > >> >>> >> >>> >>if
> > >> >>> >> >>> >> >I've characterised the
content/purpose of these various
> > >> >>>links:
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >*The spec for how plugins
are declared is here:
> > >> >>> >> >>> >> >https://github.com/alunny/cordova-plugin-spec
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >The implementation that
manages plugin usage is here:
> > >> >>> >> >>> >>
> > >> >>> >> >>>>
> > >> >>>
> > https://github.com/apache/incubator-cordova-labs/tree/cordova-client
> > >> >>> >> >>> >> >This project encompasses
more than just plugins because
> > it
> > >> >>>also
> > >> >>> >> >>>handles
> > >> >>> >> >>> >> >everything related to building,
deploying, and managing
> > >> >>>cordova
> > >> >>> >> >>> >> >applications
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >These plugins are most
popular, and should ideally work
> > >> >>>with the
> > >> >>> >> >>> >> >cordova-client implemenation:
> > >> >>> >> >>> >> >http://github.com/phonegap/phonegap-plugins*
> > >> >>> >> >>> >> >*
> > >> >>> >> >>> >> >*
> > >> >>> >> >>> >> >This implementation by
Drew was an initial proof of
> > >> concept,
> > >> >>> >>which
> > >> >>> >> >>>only
> > >> >>> >> >>> >> >works for blackberry and
has been abandoned in favor of
> > >> >>> >> >>>cordova-client,
> > >> >>> >> >>> >> >with much of his ideas
having made it into
> > cordova-client:
> > >> >>> >> >>> >> >
> https://github.com/deedubbu/cordova-blackberry-pluggable
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >This doc contains some
info on the format of the
> command
> > >> >>>line
> > >> >>> >> >>>interface
> > >> >>> >> >>> >> >and
> > >> >>> >> >>> >> >directory structure of
cordova-client:
> > >> >>> >> >>> >> >
> http://wiki.apache.org/cordova/CommandLineToolingDesign
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >This doc contains some
documentation on Drew's old
> > >> >>> >>implementation,
> > >> >>> >> >>>and
> > >> >>> >> >>> >>is
> > >> >>> >> >>> >> >out of date now:
> > >> >>> >> >>> >> >http://wiki.apache.org/cordova/PluginDesign
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >I want to emphasize that
I'm just trying to get a
> handle
> > on
> > >> >>>what
> > >> >>> >> >>>docs
> > >> >>> >> >>> >>are
> > >> >>> >> >>> >> >relevant and which links
contain what. I'm not judging
> > >> >>>anyone's
> > >> >>> >> >>>work or
> > >> >>> >> >>> >> >anything like that. :)
If I've got the wrong idea about
> > >> what
> > >> >>> >>these
> > >> >>> >> >>> >>links
> > >> >>> >> >>> >> >represent or contain, _please_
let me know.
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >-Mike
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >*
> > >> >>> >> >>> >> >*
> > >> >>> >> >>> >> >*
> > >> >>> >> >>> >> >*
> > >> >>> >> >>> >> >*
> > >> >>> >> >>> >> >*
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >On Sat, Aug 25, 2012 at
7:12 PM, Filip Maj <
> > fil@adobe.com>
> > >> >>> >>wrote:
> > >> >>> >> >>> >> >
> > >> >>> >> >>> >> >> The cordova client
CLI tooling top-level project goes
> > >> >>> >> >>>hand-in-hand
> > >> >>> >> >>> >>with
> > >> >>> >> >>> >> >> this spec. Code here:
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >>
> > >> >>> >> >>> >>
> > >> >>> >> >>>
> > >> >>> >> >>>
> > >> >>> >>
> > >> >>>
> > >> >>>
> > >>
> > https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-labs.git;a=s
> > >> >>> >> >>>h
> > >> >>> >> >>> >> >>or
> > >> >>> >> >>> >> >> tlog;h=refs/heads/cordova-client
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >> >> Essentially: vet the
spec out to make sure popular
> > >> >>>plugins out
> > >> >>> >> >>>in the
> > >> >>> >> >>> >> >>wild
> > >> >>> >> >>> >> >> (see github.com/phonegap/phonegap-plugins)
work with
> > >> this
> > >> >>> >>spec.
> > >> >>> >> >>>Do
> > >> >>> >> >>> we
> > >> >>> >> >>> >> >>need
> > >> >>> >> >>> >> >> to account for anything
else?
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >> >> I think the one outstanding
question is how to handle
> > >> >>> >> >>>installation /
> > >> >>> >> >>> >> >> compatibility with
different versions of cordova.
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >> >> Documentation for
the tool as well as the spec (put
> it
> > on
> > >> >>>the
> > >> >>> >> >>>wiki,
> > >> >>> >> >>> >> >> perhaps) would be
awesome!
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >> >> On 8/25/12 10:23 AM,
"Mike Reinstein"
> > >> >>> >><reinstein.mike@gmail.com>
> > >> >>> >> >>> >>wrote:
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >> >> >Hi Brian, Filip,
> > >> >>> >> >>> >> >> >
> > >> >>> >> >>> >> >> >Thanks for the
pointers to those projects. I'd love
> to
> > >> >>>dig in
> > >> >>> >> >>>and
> > >> >>> >> >>> >>start
> > >> >>> >> >>> >> >> >helping, where
do you feel the most help is needed
> at
> > >> the
> > >> >>> >> >>>moment?
> > >> >>> >> >>> >> >> >Documentation?
Any specific code tasks?
> > >> >>> >> >>> >> >> >
> > >> >>> >> >>> >> >> >-Mike
> > >> >>> >> >>> >> >> >
> > >> >>> >> >>> >> >> >
> > >> >>> >> >>> >> >> >
> > >> >>> >> >>> >> >> >On Sat, Aug 25,
2012 at 12:51 PM, Filip Maj
> > >> >>><fil@adobe.com>
> > >> >>> >> >>>wrote:
> > >> >>> >> >>> >> >> >
> > >> >>> >> >>> >> >> >> Also, this
is the current de-facto plugin "spec"
> we
> > >> are
> > >> >>> >> >>>working
> > >> >>> >> >>> >> >>towards:
> > >> >>> >> >>> >> >> >> https://github.com/alunny/cordova-plugin-spec
> > >> >>> >> >>> >> >> >>
> > >> >>> >> >>> >> >> >> On 8/6/12
8:20 PM, "Brian LeRoux" <b@brian.io>
> > wrote:
> > >> >>> >> >>> >> >> >>
> > >> >>> >> >>> >> >> >> >Hi Mike,
you've come to the right place!
> Currently
> > >> the
> > >> >>> >>plugin
> > >> >>> >> >>> >> >>tooling
> > >> >>> >> >>> >> >> >> >is being
implemented by Anis, Fil, Michael, and
> > >> >>>myself.
> > >> >>> >> >>>(sorry
> > >> >>> >> >>> >>for
> > >> >>> >> >>> >> >>the
> > >> >>> >> >>> >> >> >> >delayed
response / many of us are on a summer
> break
> > >> >>>after
> > >> >>> >> >>> >>shipping
> > >> >>> >> >>> >> >> >> >2.0)
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >We're
loosely collaborating using this list, git,
> > and
> > >> >>> >>these
> > >> >>> >> >>>wiki
> > >> >>> >> >>> >> >>pages:
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >- http://wiki.apache.org/cordova/PluginDesign
> > >> >>> >> >>> >> >> >> >-
> > >> >>>http://wiki.apache.org/cordova/CommandLineToolingDesign
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >The dev
is taking place a Cordova/Labs branch
> which
> > >> >>>you
> > >> >>> >>can
> > >> >>> >> >>> >>preview
> > >> >>> >> >>> >> >>on
> > >> >>> >> >>> >> >> >> >the Github
mirror here:
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >>
> > >> >>> >>
> > >> https://github.com/apache/incubator-cordova-labs/tree/cordova-client
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >You will
want to start by reading up on our
> contrib
> > >> >>> >>process
> > >> >>> >> >>>in
> > >> >>> >> >>> >>the
> > >> >>> >> >>> >> >> >>wiki:
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >
> http://wiki.apache.org/cordova/ContributerWorkflow
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >And in
the case of labs projects everything stays
> > on
> > >> >>>its
> > >> >>> >>own
> > >> >>> >> >>> >>branch
> > >> >>> >> >>> >> >> >> >until
such a time that we feel its solid for its
> > own
> > >> >>>repo.
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >* * *
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >Let me
know any q's!
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >
> > >> >>> >> >>> >> >> >> >On Mon,
Jul 30, 2012 at 4:18 PM, Mike Reinstein
> > >> >>> >> >>> >> >> >> ><reinstein.mike@gmail.com>
wrote:
> > >> >>> >> >>> >> >> >> >>
Hey there,
> > >> >>> >> >>> >> >> >> >>
> > >> >>> >> >>> >> >> >> >>
I'm interested in contributing to the plugin
> > system
> > >> >>> >>that is
> > >> >>> >> >>> >> >> >> >>forthcoming.
Is
> > >> >>> >> >>> >> >> >> >>
this the right place to bring it up? Who are
> the
> > >> >>>right
> > >> >>> >> >>>people
> > >> >>> >> >>> >>to
> > >> >>> >> >>> >> >>talk
> > >> >>> >> >>> >> >> >> >>to?
> > >> >>> >> >>> >> >> >> >>
Where do you need the most help? I'm an
> > experienced
> > >> >>> >> >>>developer,
> > >> >>> >> >>> >> >>have
> > >> >>> >> >>> >> >> >> >>worked
> > >> >>> >> >>> >> >> >> >>
on a few phonegap based projects, and would
> love
> > to
> > >> >>>give
> > >> >>> >> >>>back
> > >> >>> >> >>> >>to
> > >> >>> >> >>> >> >>the
> > >> >>> >> >>> >> >> >> >>
community.
> > >> >>> >> >>> >> >> >> >>
> > >> >>> >> >>> >> >> >> >>
cheers,
> > >> >>> >> >>> >> >> >> >>
> > >> >>> >> >>> >> >> >> >>
-Mike
> > >> >>> >> >>> >> >> >>
> > >> >>> >> >>> >> >> >>
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >> >>
> > >> >>> >> >>> >>
> > >> >>> >> >>> >>
> > >> >>> >> >>>
> > >> >>> >> >>>
> > >> >>> >>
> > >> >>> >>
> > >> >>>
> > >> >>>
> > >>
> > >>
> > >
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message