[xwiki-devs] Naming convention for webjar modules

[Marius Dumitru Florea]

Hi devs,

I recently added two modules (on a branch, see
https://github.com/xwiki/xwiki-platform/commit/de32b71e315def995b5f21b7033930a0309caa97
) that generate webjars and I'm not sure whether the names I've used
are good enough:

xwiki-platform-job-web
xwiki-platform-tree-widget

Thomas made me realize that -web suffix is confusing because we use it
for modules that generate a WAR. I didn't use -widget for the first
because it's not a widget (unlike the tree) but some JavaScript API.
An alternative I had in mind and which was also suggested by Thomas is
-webjar but we normally don't put the packaging type as suffix. We
have -ui and not -xar for instance.

So WDYT?

(1) Is -webjar a good suffix for modules that generate a webjar?

(2) If yes, then should it be used for all webjar modules? I.e. rename
-widget to -webjar

I'd say yes for both.

Thanks,
Marius

[Thomas Mortagne]

Ok for both too.

On Tue, Oct 21, 2014 at 6:04 PM, Marius Dumitru Florea

Post by Marius Dumitru Florea
Hi devs,
I recently added two modules (on a branch, see
https://github.com/xwiki/xwiki-platform/commit/de32b71e315def995b5f21b7033930a0309caa97
) that generate webjars and I'm not sure whether the names I've used
xwiki-platform-job-web
xwiki-platform-tree-widget
Thomas made me realize that -web suffix is confusing because we use it
for modules that generate a WAR. I didn't use -widget for the first
because it's not a widget (unlike the tree) but some JavaScript API.
An alternative I had in mind and which was also suggested by Thomas is
-webjar but we normally don't put the packaging type as suffix. We
have -ui and not -xar for instance.
So WDYT?
(1) Is -webjar a good suffix for modules that generate a webjar?
(2) If yes, then should it be used for all webjar modules? I.e. rename
-widget to -webjar
I'd say yes for both.
Thanks,
Marius
_______________________________________________
devs mailing list
http://lists.xwiki.org/mailman/listinfo/devs