README

A Neos Fusion DSL implementation based on tagged template literals in javascript.

composer require prgfx/fusion-template-literals

Usage

By default this package defines the DSL identifier plain, but you can alias it for more meaningful tags for your application.

p = Some.Example:Prototype {
    value = plain`Some text with ${I18n.translate('interpolated')} values`
}

This package comes with two implementations: an array-renderer (creating a fusion array-like object (e.g. Neos.Fusion:Array or Neos.Fusion:Join as per configuration)) and an eel-expression renderer.
The latter has the advantage that you may reference variables as ${this.variable} as it would seem intuitive:

trackingId = ${Configuration.setting(...)}
snippet = inline`(w=> { w.qa=w.qa||[];w.qa.push('create', '${this.trackingId}');})(window);`

However this does not work well with multiline blocks as the eel expression does not properly output newlines. This would be fine for snippets like shown above with block mode compress (see below). (After all this package mainly targets such scenarios.)

Multiline blocks

Given a block-mode modifier in the first line (and nothing else in this line), multiline blocks may be interpreted differently. The block-mode modifier can be configured in Prgfx.Fusion.TemplateLiterals.blockDelimiters to your preferences. There are different multiline block-modes:

default

only cut off surrounding empty lines, keeps the rest as is

value = plain`
    line 1
    line 2
`
// will not contain the first and last "empty" line

block

will trim all indentation

value = plain`|
    line 1
        line 2
    line 3
`
// will return 'line 1\n    line 2\nline3'

singleLine

will trim all indentation and join newlines with a single space.
double newlines will create a line break.

value = plain`>
    line 1
    line 2

    line 3
`
// 'line 1 line 2\nline3'

compress

compared to singleLine will remove all surrounding whitespace per line:

value = plain`>>
if (foo) {
    console.log(foo);
}
`
// 'if (foo) { console.log(foo); }'

Custom implementations

This package is implemented in a way that you can easily extend the PlainTemplateLiterals implementation and override the generateCode method. This method receives stringParts: string[] and ...expressions: string[] just like the javascript equivalent.

prgfx / fusion-template-literals

Maintainers

Details