[NPMCLI-59] Update page prototype to reflect changed name of resources templating functions Created: 08/Dec/16  Updated: 18/Jan/17  Resolved: 19/Dec/16

Status: Closed
Project: Magnolia CLI
Component/s: None
Affects Version/s: None
Fix Version/s: 1.0.7

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 7.5h
Original Estimate: Not Specified

Issue Links:
relation
is related to MGNLRES-293 Add RESFN templating functions Closed
is related to NPMCLI-67 show instructions how to continue aft... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Sprint: Saigon 75

 Description   

Context

Update page prototype to reflect changed name of resources templating functions.

With MGNLRES-293 the resources templating functions move from https://github.com/rah003/neat-resources to the magnolia-resources modules.

The identifier / name of the registered context attribute has changed from hcmcfn to resfn.
mgnl-cli-prototypes/page/template.ftl
must be adapted.

Tasks

update prototype page template script

Currently the prototype for the page template script contains this snippet (and others):

[#-- ${hcmcfn.css(["__lightDevModuleFolder__/.*.css"])!} --]

It should be replaced by:

[#-- ${resfn.css(["__lightDevModuleFolder__/.*.css"])!} --]
update mgnl-cli.json

Remove neat-resources from mgnl-cli.json/downloadJars.

document downloadJars config section

Document downloadJars in the ReadMe and the Magnolia CLI docs page.



 Comments   
Comment by Federico Grilli [ 09/Dec/16 ]

At this point, I'd remove the downloadJars field from mgnl-cli.json since, afaik, we no longer use neat-resources. downloadJars would need to be documented at https://documentation.magnolia-cms.com/display/DOCS/Magnolia+CLI#MagnoliaCLI-mgnl-cli.json anyway. Unfortunately, being JSON it can't be left in the file commented out, so as to serve as an example.

Comment by Christoph Meier [ 11/Dec/16 ]

Good point(s) fgrilli.

  • Indeed neat-resources can be removed then from the list of extra jars (downloadJars).
  • But not before magnolia-resources module and or the bundles having the latest reources-modules has been released.
  • Would this mean that Magnolia-CLI must be released at latest with the next minor release?
  • Yes, "downloadJars" section in the mgnl-cli.json cannot contain comments and there is no more need to download an extra library.
  • Ergo it mist be properly documented
Comment by Federico Grilli [ 12/Dec/16 ]

Would this mean that Magnolia-CLI must be released at latest with the next minor release?

According to https://docs.npmjs.com/getting-started/semantic-versioning

New features which don't break existing features: Minor release, increment the middle number, e.g. 1.1.0

So, if we remove that bit in mgnl-cli.json and someone relying on neat-resources updates the CLI we kind of break it. Of course, they can re-add downloadJars in their custom mgnl-cli.json. I think it kind of sucks to bump to 2.0.0 after a few weeks from the first release and only for this removal. Also I don't expect so many people to actually rely on that library. I'd go for a minor release and explain in the docs what happened and what you need to have downloadJars back, in case you need it. My two cents.

Comment by Christoph Meier [ 16/Dec/16 ]

Please let's NOT close ticket before the new submodule has been added to empty-webapp at ce.

Generated at Mon Feb 12 04:46:08 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.