Built-in Helpers

There are many helper functions available for the scaffdog template engine.

Helpers#

camel#

Conversion to a camel case.

Signature:

camel(value)

Paramters:

Example:

{{ "foo-bar" | camel }}
--> fooBar

snake#

Conversion to a snake case.

Signature:

snake(value)

Paramters:

Example:

{{ "foo-bar" | snake }}
--> foo_bar

pascal#

Conversion to a pascal case.

Signature:

pascal(value)

Paramters:

Example:

{{ "foo-bar" | pascal }}
--> FooBar

kebab#

Conversion to a kebab case.

Signature:

kebab(value)

Paramters:

Example:

{{ "foo-bar" | kebab }}
--> foo-bar

constant#

Conversion to a constant case.

Signature:

constant(value)

Paramters:

Example:

{{ "foo-bar" | constant }}
--> FOO_BAR

upper#

Conversion to a upper case.

Signature:

upper(value)

Paramters:

Example:

{{ "foo-bar" | upper }}
--> FOO-BAR

lower#

Conversion to a lower case.

Signature:

lower(value)

Paramters:

Example:

{{ "FOO-BAR" | lower }}
--> foo-bar

plur#

Pluralize a word. See the plur documentation for details.

Signature:

plur(value, count?)

Paramters:

Example:

{{ "dog" | plur }}
--> dogs

{{ "dog" | plur 1 }}
--> dog

{{ "dog" | plur 2 }}
--> dogs

replace#

Replace pattern with replacement. pattern is specified as a string, but it is treated as a regular expression.

Signature:

replace(value, pattern, replacement)

Paramters:

Example:

{{ "foo-bar" | replace "-" "/" }}
--> foo/bar

trim#

Alias for String.prototype.trim.

Signature:

trim(value)

Paramters:

Example:

{{ " foo " | trim }}
--> "foo"

ltrim#

Alias for String.prototype.trimStart.

Signature:

ltrim(value)

Paramters:

Example:

{{ " foo " | ltrim }}
--> "foo "

rtrim#

Alias for String.prototype.trimEnd.

Signature:

rtrim(value)

Paramters:

Example:

{{ " foo " | rtrim }}
--> " foo"

seq#

Generates a numeric array for the specified range. Similar signature to the seq command.

Signature:

seq(first, increment?, last?)

Paramters:

Example:

{{ seq 5 }}
--> 1,2,3,4,5

{{ seq 0 5 }}
--> 0,1,2,3,4,5

{{ seq 1 2 10 }}
--> 1,3,5,7,9

append#

Appends elements to an array and returns the resulting array. The array received as an argument is not modified, and immutable operations are performed.

Signature:

append(value, ...args)

Paramters:

Example:

{{ seq 3 | append 10 }}
--> 1,2,3,10

{{ seq 3 | append 4 | append 5 }}
--> 1,2,3,4,5

uniq#

Takes duplicates from array elements and returns the resulting array. The array received as an argument is not modified, and immutable operations are performed.

Signature:

uniq(value)

Paramters:

Example:

{{ arr := seq 2 | append 1 | append 2 | append 3 }}
{{ arr }}
--> 1,2,1,2,3

{{ arr | uniq }}
--> 1,2,3

split#

Alias for String.prototype.split.

Signature:

split(value, sep)

Paramters:

Example:

{{ "1/2/3" | split "/" }}
--> 1,2,3

join#

Alias for Array.prototype.join.

Signature:

join(value, sep)

Paramters:

Example:

{{ "1/2/3" | split "/" | join "_" }}
--> 1_2_3

len#

Returns the length of the value. If the length cannot be determined, returns 0.

Signature:

len(value)

Paramters:

Example:

{{ "123" | len }}
--> 3

slice#

Returns portion of an array. Similar signature to String.prototype.slice.

Signature:

slice(value, start, end?)

Paramters:

Example:

{{ "12345" | slice 2 }}
--> 345

{{ "12345" | slice 1 3 }}
--> 23

contains#

Searches for an item in a string or array and returns a boolean value.

Signature:

contains(search, item)

Paramters:

Example:

{{ contains("foo", "o") ? "true" : "false" }}
--> true

{{ contains("foo", "b") ? "true" : "false" }}
--> false

{{ contains(seq(3), 2) ? "true" : "false" }}
--> true

{{ contains(seq(3), 4) ? "true" : "false" }}
--> false

s2n#

Converts a string to a number.

Signature:

s2n(value)

Paramters:

Example:

{{ "123" | s2n }}
--> 123

n2s#

Converts a number to a string.

Signature:

n2s(value)

Paramters:

Example:

{{ 123 | n2s }}
--> "123"

before#

Returns string before the position by n. If n is a number, it is the specified line; if it is a string, it is the first matched line.

See the Injection section for more information on how to make use of it.

Signature:

before(value, n, offset?)

Paramters:

Example:

{{ "line1
line2
line3" | before "line2" }}
--> line1

after#

Returns string after the position by n. If n is a number, it is the specified line; if it is a string, it is the first matched line.

See the Injection section for more information on how to make use of it.

Signature:

after(value, n, offset?)

Paramters:

Example:

{{ "line1
line2
line3" | after "line2" }}
--> line3

eval#

Executes the specified code as JavaScript and returns the result.

Signature:

eval(code)

Paramters:

Example:

{{ eval "1 + 2" }}
--> 3

date#

See the dayjs documentation for format details.

Signature:

date(format?)

Paramters:

Example:

{{ date "YYYY/MM/DD" }}
--> 2019/01/06

noop#

Returns an empty string.

Signature:

noop()

Example:

{{ "foo" | upper | noop }}
-->

define#

Defines a local variable in the template scope.

Signature:

define(value, key)

Paramters:

Example:

{{- "foo-bar" | camel | define "name" -}}
{{ name }}
--> fooBar

relative#

Convert the path from the template file to the path from the destination file.

Signature:

relative(path)

Paramters:

Example:

{{ relative "../src/utils" }}

resolve#

Resolves a sequence of paths or path segments into an absolute path.

Signature:

resolve(...paths)

Paramters:

Example:

{{ resolve "../src" "common" }}

read#

Read the specified file. The contents of the loaded file are also expanded as a template.

Signature:

read(path)

Paramters:

Example:

{{ resolve "../src" "common" }}