Project templates are simple the bare bones of your project with key parts where you would put things like the project name replaced wit Jinja2 template syntax.
These templates can live locally on your file system or they can live on a remote git repository. See Usage for more on this.
This is a basic HTML project template:
<html>
<head>
<title>{{ PROJECT_NAME }}</title>
</head>
<body>
<h1>Hello world, I am {{ PROJECT_NAEME }}</h1>
</body>
</html>
In the above example {{ PROJECT_NAME }} will be replaced with what ever you set the project name to be in the command, so for example: $ facio -n foo would result in {{ PROJECT_NAME }} being replaced by foo.
Your project can be made up of any file types, any directory structure, it all gets copied over and processed.
Of course project name is not always enough and in these situations you can send extra variables to facio to use in the template processing. To do this run facio with the --vars flag passing a comma separated list, for example:
facio -n hello_world --vars foo=bar,something=else
Accessing these variables in templates is easy:
Hello World
foo={{ foo }}
something={{ something }}
As Jinja2 is used to render the templates, you can use conditions, and other Jinja2 functionality, for example:
{% if foo=='bar' %}
Foo is bar
{% else %}
Foo is not bar
{% endif %}
See the Jinja2 Documentation.
You can even rename a directory and/or file by using double underscores around the variable name, for example:
- /path/to/template/
- __foo__/
- another.txt
- __foo__.txt
- some_file.txt
- some_other_file.txt
- /path/to/template/
- bar/
- another.txt
- bar.txt
- some_file.txt
- some_other_file.txt