The files contained within the templates/ folder are extremely similar to the files that are copied verbatim to the target system, but they follow a naming convention and are processed by a template system.
Templates can be used by any function that installs files via wickMakeFile (from wick-base). Typically you can just pass --template to enable template processing.
# This copies from files/filename.sh to /tmp/filename.sh
wickMakeFile filename.sh /tmp/
# This uses a template in templates/filename.sh and the shell
# template engine to generate /tmp/filename (no suffix)
wickMakeFile --template filename.sh /tmp/
When the destination is a directory, the template engine suffix is removed before the file is saved.
Template engines can be added by just including the right formulas. As an example, you can add mo as a dependency and then mustache templates can be used.
Enable mustache templates by including the mo formula.
Example depends file:
#!/usr/bin/env bash
wickFormula mo
Example run script:
#!/usr/bin/env bash
export NAME="Betty"
export LIST=(one two three)
wickMakeFile --template name.mo /tmp
Example templates/name.mo:
Your name is {{NAME}}
{{LIST}}
Item: {{.}}
{{/LIST}
Example result in /tmp/name:
Your name is Andrew
Item: one
Item: two
Item: three
This is the only template system that exists by default. It is assumed that the files are shell scripts and the stdout from the shell script will be the contents of the file that will be saved. If the shell script reports failure, the installation process is aborted. (See [Bash concepts] for stdout and failure.)
The shell scripts can read from the environment or do anything that shell commands can normally do.
Example run script:
#!/usr/bin/env bash
export NAME="Andrew"
wickMakeFile --template name.sh /tmp/
Example templates/name.sh:
#!/usr/bin/env bash
echo "Your name is $NAME"
Example result in /tmp/name:
Your name is Andrew