Vanilla Macro loader example (DO NOT MERGE)

[pastelcyborg]

This PR exists solely to demonstrate examples and experiments for loading Vanilla Macros from node_modules/ using Flask/Jinja. A permanent solution will likely be integrated into Flask Base directly.

DO NOT MERGE.

[webteam-app]

Demo

Jenkins

demos.haus

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.51%. Comparing base (f8e9844) to head (8d5943a).
Report is 8 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #14209      +/-   ##
==========================================
- Coverage   69.57%   69.51%   -0.06%     
==========================================
  Files         120      120              
  Lines        3412     3412              
  Branches     1172     1172              
==========================================
- Hits         2374     2372       -2     
- Misses       1013     1015       +2     
  Partials       25       25              

see 1 file with indirect coverage changes

[jmuzina]

This is much simpler than I thought it would be!

[britneywwc]

This is great, thank you! :)

I tried running the example on demo and it's throwing 500, running it locally shows that the macros are not found.

Upon checking, there are no templates/ files under node_modules/vanilla_framework. Is this soon to be added from Vanilla's side?

[pastelcyborg]

This is great, thank you! :)

I tried running the example on demo and it's throwing 500, running it locally shows that the macros are not found.

Upon checking, there are no templates/ files under node_modules/vanilla_framework. Is this soon to be added from Vanilla's side?

Vanilla in this project would need to be upgraded to at least 4.15.0 to get the patterns.

[pastelcyborg]

@britneywwc Actually, a few other minor changes will need to be made to Vanilla as well, because the macros directory is not currently published as part of the npm package, so unfortunately this server change won't be useful until those changes are made. Sorry about that!

[jmuzina]

What happens if a project has a file in templates with the exact same file path as a macro we publish that they'd like to use?

My assumption is the project's template will be used since it's listed first here. However this means we are slightly restricting the file structure of projects that use flask base.

This isn't a bad thing, but maybe we should add some logic that outputs warnings if any identical file-paths are found between these two directories?

[pastelcyborg]

Yep, I'd been wondering the same thing - maybe the filenames of our macros should be namespaced somehow (vf.tiered_list.jinja or whatever)?

[jmuzina]

Yep, I'd been wondering the same thing - maybe the filenames of our macros should be namespaced somehow (vf.tiered_list.jinja or whatever)?

I'd support that.