Add a flag to toggle class-templating-syntax #25

Bpolitycki · 2023-12-05T18:48:08Z

This commit / PR adds a simple setting, which can be toggled by the configuration as part of the templating-model, to control if the old class based templating syntax (class='foo:bar') is interpreted as a call to a xquery function. This will allow to usage of colons inside classes (e.g. to use TailwindCSS)

duncdrum · 2023-12-05T22:19:11Z

The feature seems useful to me. Could you please add a test case and address the failing tests. We also need to document the feature in the templating article in documentation repo.

Bpolitycki · 2023-12-06T08:55:15Z

The feature seems useful to me. Could you please add a test case and address the failing tests. We also need to document the feature in the templating article in documentation repo.

Great. Added tests and fixed the problem with the tests (I don't why, but I deleted the casting to booleans before).

So the place for the documentation would be over here: Templating Docs?

duncdrum · 2023-12-06T08:59:35Z

@Bpolitycki yes that is the spot. I ll try to take a look at the CI config later today. Your changes don't seem to have caused all these failures.

Bpolitycki · 2023-12-06T09:01:16Z

@Bpolitycki yes that is the spot. I ll try to take a look at the CI config later today. Your changes don't seem to have caused all these failures.

Perfect – thanks. When running the tests locally, all tests are passing.

Bpolitycki · 2023-12-06T09:39:47Z

I think there is a mistake in my approach (which was not covered by the tests).

https://github.com/Bpolitycki/exist-db-templating/blob/3fae54424b43676a1dbff6a5c04ba4cc15db6862/content/templates.xqm#L152C25-L152C25

Will stop the execution of templates on childs.

line-o

Thanks for your contribution. I like the feature.
Here are some things I would like to see:

I would prefer if we test different configurations as part of the unit tests
Please separate commits into changes, fixes and formatting where possible otherwise it is really hard to see what actually changed.
With which tool did you reformat the JS code and with what settings? We should be on the same page as to not constantly reformat those sources. Maybe best is to leave it out of this PR and first find common ground and set that as a separate build step.

package.json

content/templates.xqm

line-o · 2023-12-06T13:23:51Z

test/mocha/rest_spec.js

@@ -11,17 +11,17 @@ const { origin } = new URL(serverInfo.server);
 const app = `${origin}/exist/apps/templating-test`;

 const axiosInstance = axios.create({
-  baseURL: app
+  baseURL: app,


The comma is not necessary here.

It should not be part of this PR. See my comment on formatting above.

content/templates.xqm

line-o · 2023-12-06T13:35:23Z

content/templates.xqm

@@ -136,21 +138,26 @@ declare function templates:process($nodes as node()*, $model as map(*)) {
                return
                    if ($dataAttr) then
                        templates:call($dataAttr, $node, $model)
-                    else
+                    else if (($model($templates:CONFIGURATION)($templates:CONFIG_USE_CLASS_SYNTAX), $templates:SEARCH_IN_CLASS)[1]) then


$templates:CONFIG_USE_CLASS_SYNTAX should be set to true() in default configuration.
This will make the condition here much simpler as we can be sure this key is always set.

templating/content/templates.xqm

Line 93 in c0f6e4b

declare %private function templates:get-default-config($resolver as function(xs:string, xs:integer) as item()?) as map(*) {

else if ($model?($templates:CONFIGURATION)?($templates:CONFIG_USE_CLASS_SYNTAX)) then

Implemented in the suggested way. See 0a9b651

line-o · 2023-12-06T13:43:31Z

test/app/modules/view.xql

 let $config := map {
    $templates:CONFIG_APP_ROOT : $test:app-root,
-    $templates:CONFIG_STOP_ON_ERROR: true()
+    $templates:CONFIG_STOP_ON_ERROR: true(),
+    $templates:CONFIG_USE_CLASS_SYNTAX: xs:boolean(request:get-parameter('classLookup', $templates:SEARCH_IN_CLASS))


I would prefer to have different configurations to be checked as part of the unit tests. (see

templating/test/xqs/test-suite.xqm

Line 61 in c0f6e4b

declare variable $tt:config-no-filter := map {

and following)

line-o · 2023-12-06T17:03:22Z

@Bpolitycki If you need help or have further question, don't hesitate to ask here or on our community slack channel.

Bpolitycki · 2023-12-08T13:11:31Z

@Bpolitycki If you need help or have further question, don't hesitate to ask here or on our community slack channel.

@line-o Thanks for you feedback – I will have a look at the comments and try to fix the marked issued.

This commit adds a simple setting, which can be toggled by the configuration as part of the templating-model, to control if the old class based templating syntax (class='foo:bar') is interpreted as a call to a xquery function. This will allow to usage of colons inside classes (e.g. to use TailwindCSS)

This commit introduces a helper function (`templates:process-children`), which will ensure that all templates are called recursive. This is a fixes the bug introduces in the previous feature commit.

…configuration

Bpolitycki · 2024-01-18T10:31:24Z

@line-o – I'm really sorry, but it took quite a while to come back on this PR again.

I've worked on some of the requested changes – but a few are left open.

I think the changes to the JS-formatting was done by VSCode (Prettier) – which formatter do you prefer? Let me know and I can fix the formatting.
The test setup is a bit confusing for me. What's the purpose of splitting tests between JS and XQuery? Maybe you can give me an additional hint on how to implement the requested test scenario.

Thanks in advance!

line-o · 2024-01-22T11:16:58Z

@Bpolitycki Tests are split for two reasons:

XQuery: unit tests, allow to test different configurations
JS: integration tests

line-o · 2024-01-22T11:25:14Z

I, personally, do prefer standard. It is used in node-exist and xst.

Bpolitycki force-pushed the master branch from d879bb3 to 3f5bbe8 Compare December 6, 2023 08:49

Bpolitycki force-pushed the master branch from 3f5bbe8 to 3fae544 Compare December 6, 2023 08:59

line-o requested changes Dec 6, 2023

View reviewed changes

Bpolitycki added 3 commits January 18, 2024 11:15

Fix recursive template execution for child nodes

45b8a06

This commit introduces a helper function (`templates:process-children`), which will ensure that all templates are called recursive. This is a fixes the bug introduces in the previous feature commit.

Added $templates:CONFIG_USE_CLASS_SYNTAX to the default templating-…

0a9b651

…configuration

Bpolitycki force-pushed the master branch from bf8cba3 to 0a9b651 Compare January 18, 2024 10:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a flag to toggle class-templating-syntax #25

Add a flag to toggle class-templating-syntax #25

Bpolitycki commented Dec 5, 2023

duncdrum commented Dec 5, 2023

Bpolitycki commented Dec 6, 2023

duncdrum commented Dec 6, 2023

Bpolitycki commented Dec 6, 2023

Bpolitycki commented Dec 6, 2023

line-o left a comment •

edited

Loading

line-o Dec 6, 2023

line-o Dec 6, 2023

line-o Dec 6, 2023 •

edited

Loading

line-o Dec 6, 2023

Bpolitycki Jan 18, 2024

line-o Dec 6, 2023

line-o commented Dec 6, 2023

Bpolitycki commented Dec 8, 2023 •

edited

Loading

Bpolitycki commented Jan 18, 2024

line-o commented Jan 22, 2024

line-o commented Jan 22, 2024

Add a flag to toggle class-templating-syntax #25

Are you sure you want to change the base?

Add a flag to toggle class-templating-syntax #25

Conversation

Bpolitycki commented Dec 5, 2023

duncdrum commented Dec 5, 2023

Bpolitycki commented Dec 6, 2023

duncdrum commented Dec 6, 2023

Bpolitycki commented Dec 6, 2023

Bpolitycki commented Dec 6, 2023

line-o left a comment • edited Loading

Choose a reason for hiding this comment

line-o Dec 6, 2023

Choose a reason for hiding this comment

line-o Dec 6, 2023

Choose a reason for hiding this comment

line-o Dec 6, 2023 • edited Loading

Choose a reason for hiding this comment

line-o Dec 6, 2023

Choose a reason for hiding this comment

Bpolitycki Jan 18, 2024

Choose a reason for hiding this comment

line-o Dec 6, 2023

Choose a reason for hiding this comment

line-o commented Dec 6, 2023

Bpolitycki commented Dec 8, 2023 • edited Loading

Bpolitycki commented Jan 18, 2024

line-o commented Jan 22, 2024

line-o commented Jan 22, 2024

line-o left a comment •

edited

Loading

line-o Dec 6, 2023 •

edited

Loading

Bpolitycki commented Dec 8, 2023 •

edited

Loading