ffizer is a files and folders initializer / generator. Create any kind (or part) of project from template.
keywords: file generator, project template, project scaffolding, quickstart, project initializer, project skeleton
Some of the following limitations could change in the future (depends on gain/loss):
Download the binary for your platform from github releases, then unarchive it and place it your PATH.
sh
cargo install ffizer
```txt ffizer 0.7.1 davidB ffizer is a files and folders initializer / generator. Create any kind (or part) of project from template.
USAGE:
ffizer [FLAGS] [OPTIONS] --destination
FLAGS: -h, --help Prints help information --offline in offline, only local templates or cached templates are used -V, --version Prints version information -v, --verbose Verbose mode (-v, -vv (very verbose / level debug), -vvv) print on stderr --x-alwaysdefaultvalue should not ask for valiables values, always use defautl value or empty (experimental)
OPTIONS:
--confirm
sh
ffizer --source $HOME/my_templates/tmpl0 --destination my_project
use a remote git repository as template
sh
ffizer --source https://github.com/davidB/ffizer_demo_template.git --destination my_project
output
```sh
Configure variables
projectname: myproject
Plan to execute
file priority (what file will be used if they have the same destination path)
txt
existing file
file with source extension .ffizer.hbs (and no {{...}} in the source file path)
file with identical source file name (and extension)
file with {{...}} in the source file path
create the folder with the template
sh
mkdir my-template
cd my-template
add file that will be copied as is
sh
cat > file0.txt <<EOF
I am file0.
EOF
add a template file that will be "rendered" by the handlebars engine
sh
cat > file1.txt.ffizer.hbs <<EOF
I am file1.txt of {{ project }}.
EOF
add a ffizer configuration file (.ffizer.yaml)
```yaml variables:
ignores:
add a file with a name that will be "rendered" by the handlebars engine
sh
cat > '{{ project }}.txt' <<EOF
I am a fixed content file with rendered file name.
EOF
Some variables are predefined and they can be used into ffizer.yaml into the ignores section or default_value via handlebars expression.
yaml
variables:
- name: project_name
default_value: "{{ file_name ffizer_dst_folder }}"
The predefined variables are:
ffizer_dst_folder contains the value from cli arg --destinationffizer_src_rev contains the value from cli arg --revffizer_src_uri contains the value from cli arg --sourceHelpers extend the template to generate or to transform content. Few helpers are included, but if you need more helpers, ask via an issue or a PR.
To use an helper:
handlebars
{{ helper_name argument}}
To chain helpers, use parenthesis:
handlebars
{{ to_upper_case (to_singular "Hello foo-bars") }}
// -> "BAR"
see Handlebars templating language
for the same input: "Hello foo-bars"
helpername | example out -- | -- tolowercase | "hello foo-bars" touppercase | "HELLO FOO-BARS" tocamelcase | "helloFooBars" topascalcase | "HelloFooBars" tosnakecase | "hellofoobars" toscreamingsnakecase | "HELLOFOOBARS" tokebabcase | "hello-foo-bars" totraincase | "Hello-Foo-Bars" tosentencecase | "Hello foo bars" totitlecase | "Hello Foo Bars" toclasscase | "HelloFooBar" totablecase | "hellofoobars" toplural | "bars" tosingular | "bar"
Helper able to render body response from an http request.
helpername | usage -- | -- httpget | httpget "http://hello/..." gitignoreio | gitignore_io "rust"
Helper able to extract (or transform) path (defined as string).
for the same input: "/hello/bar/foo.txt"
helpername | sample output -- | -- filename | "foo.txt" parent | "/hello/bar" extension | "txt"
sh
cargo test
cargo build --release
specialized to a platform, build tool,...