gearsix 26fe1b7de4 TODO & CHANGELOG updates | 1 anno fa | |
---|---|---|
cmd | 1 anno fa | |
examples | 1 anno fa | |
CHANGELOG.md | 1 anno fa | |
LICENSE | 3 anni fa | |
README.md | 1 anno fa | |
TODO.md | 1 anno fa | |
data.go | 1 anno fa | |
data_test.go | 1 anno fa | |
file.go | 1 anno fa | |
file_test.go | 1 anno fa | |
go.mod | 2 anni fa | |
go.sum | 3 anni fa | |
template.go | 1 anno fa | |
template_test.go | 1 anno fa |
data and template interface
dati [OPTIONS]
dati aims to provide a universal interface for executing data files, written in any data-serialization language, against template files, written in any templating languages. Ideally dati will support any language you want to use.
dati works by using various libraries that do all the hard work to parse data and template files passed to it. It generates a data structure of all the passed data files combined (a super-data structure) and executes that structure against a set of root template files. The used libraries are listed below for credit/reference.
dati can also be imported as a golang package to be used as a library.
-r, -root PATH
Path of the root template file to execute against.
-p, -partial PATH ...
Path of (multiple) template files that are called upon by at least
one root template
-gd, -global-data PATH ...
Path of (multiple) data files to load as "global data".
If a directory is passed then all files within that directory will
(recursively) be loaded.
-dk, -data-key NAME
Set the name of the key used for the generated array of data. The
default data key is "data".
-sd, -sort-data ATTRIBUTE
The file attribute to order data files by. If no value is provided,
the data will be provided in the order it's loaded.
-cfg -config FILE
A data file to provide default values for the above options (CONFIG).
It's possible you'll want to set the same options if you run dati multiple times for the same project. This can be done by creating a file (written as a data file) and passing the filepath to the -cfg argument.
The key names for the options set in the config file must match the name of the argument option to set (long or short). For example (a config file in toml):
root="~/templates/blog.mst"
partial="~/templates/blog/"
gd="./blog.json"
data="./posts/"
dk="posts"
dati generates a single super-structure of all the data files passed to it. This super-structure is executed against each "root" template.
The super-structure generated by dati will only have 1 definite key: "data" (or the value of the "data-key" option). This key will overwrite any "global data" keys in the root of the super-structure. Its value will be an array, where each element is the resulting data structure of each parsed "data" file.
Parsed "global data" will be written to the root of the super-structure and into the root of each "data" array object. If a key within one of these objects conflicts with one of the "global data" keys, then that "global data" key will not be written to the object.
All "root" template files passed to dati that have a file extension matching one of the supported templating languages will be parsed and executed against the super-structure generated by dati.
All "parital" templates will be parsed into any "root" templates that have a file extension that match the same templating language.
Below is a list of the supported data-serialisation languages, used for "data" and "global data" files.
These are the currently supported templating languages, used for files passed in the "root" and "partial" arguments.
dati -cfg ./dati.cfg -r templates/textfile.mst
dati -r homepage.hmpl -p head.hmpl -p body.hmpl -gd meta.json -d posts/*
see the examples/ directory in the dati repository for a cool example.
As stated above, all of these libraries do the hard work, dati just combines it all together - so thanks to the authors. Also here for reference.