613630 - move "cfx init" command's addon templates into example addon in examples/ dir

Status: RESOLVED WONTFIX

(Add-on SDK Graveyard :: General, defect, P2)

Description

[Myk Melez [:myk] [@mykmelez]]

The python-lib/cuddlefish/templates.py file contains the contents of files created by the "cfx init" command.

Those contents would be better stored as actual files in an example addon in the examples/ directory, not only because they would be easier for addon developers to examine, but because it would then be easier for addon developers to customize the output of "cfx init" by modifying the files.

Comment 1

[Julián Ceballos]

Hi, I like the idea, but I have a question, if we put the structure in the examples folder, could developers make cfx run and cfx test at this add-on?

Comment 2

[Myk Melez [:myk] [@mykmelez]]

I believe so, yes.

Brian: is that correct?

Comment 3

[Brian Warner [:warner :bwarner]]

yes, I too think that's correct

Comment 4

[Julián Ceballos]

Well, i think that maybe the correct place to put the templates is in the folder packages, because if the user for any reason decide to delete examples directory, he/she could make the sdk crash when init is called.

I agree the idea that developer could change the lib/main.js template but i suggest put the init templates in packages folder :)

Comment 5

[Myk Melez [:myk] [@mykmelez]]

(In reply to comment #4)
> Well, i think that maybe the correct place to put the templates is in the
> folder packages, because if the user for any reason decide to delete examples
> directory, he/she could make the sdk crash when init is called.

That's true regardless of where the addon template package is stored; it isn't specific to the examples/ directory.


> I agree the idea that developer could change the lib/main.js template but i
> suggest put the init templates in packages folder :)

We are moving to a model where the packages/ directory contains only library packages by default, and users are encouraged to put their addon packages in another location (outside of the SDK directory).  Thus it is not a good location for an addon template package.

The examples/ directory, on the other hand, is where example addon packages are, and an addon template package is quite similar to an example addon package.  Thus the examples/ directory is a good location for the addon template package.

Comment 6

[Julián Ceballos]

Yes, that's true, well was just an idea, i agree, so i'll use the examples directory to put the init template.

Comment 7

[Myk Melez [:myk] [@mykmelez]]

(automatic reprioritization of 1.0 bugs)

Comment 8

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

(Pushing all open bugs to the --- milestone for the new triage system)

Comment 9

[Erik Vold [:erikvold] (please needinfo? me)]

Sorry we won't be releasing any new versions of cfx, jpm is the replacement https://www.npmjs.com/package/jpm