ffizer

ffizer is a files and folders initializer / generator. It creates or updates any kind (or part) of project from template(s).

keywords: file generator, project template, project scaffolding, quick start, project bootstrap, project skeleton

• Features
• Usages
  • Install
    • via homebrew
    • via snap
    • via github releases
    • via cargo
  • Run
    • Self upgrade the executable
    • Apply a template (to create or update)
  • Authoring a template
• Templates
• Build

Features

• Create or update files and folder from one (or several) template(s).
• A native executable (cli)
  • Install via download a standalone single file on system (no requirements like python, ruby, nodejs, java, ...).
  • Run as fast enough project generator.
  • Run with dry mode (useful to test).
  • Support self-upgrade.
• A rust library
  • Can be included into other tool
• Templates Authoring
  • Can be used for any file & folder generation (no specialization to one ecosystem).
  • Can start as simple as a folder to copy "as is".
  • Can use the [Handlebars] template syntax for file content, extended with functions:
    • To transform strings (toUpperCase, toLowerCase, Capitalize,...)
    • To retrieve content via http get (like .gitignore from gitignore.io, license from spdx)
    • ...
  • Can replace variables part in file and folder's name
  • Can be composed of other templates (applied as layer)
  • Can ignore file / folder under conditions
  • Can store the content at the root of the folder or under the sub-folder template
• Templates Hosting
  • On a local folder
  • On a hosted git repository (public / private, github / bitbucket/ gitlab / ...)
    • At the root of the repository
    • In a sub-folder of the repository
    • In any revision (branch, tag, commit)

Suggestions are welcomes ;-)

A list of alternatives is available on the wiki, feel free to complete / correct.

Usages

Install

curl https://raw.githubusercontent.com/ffizer/ffizer/master/scripts/getLatest.sh | bash

via homebrew

brew tap ffizer/ffizer
brew install ffizer-bin
ffizer upgrade

via snap

# experimental, feedback welcome
sudo snap install ffizer --edge

via github releases

Download the binary for your platform from github releases, then un-archive it and place it your PATH.

via cargo

cargo install ffizer --force --features cli

Run

➜  ffizer --help

ffizer 1.6.0
https://github.com/ffizer/ffizer
ffizer is a files and folders initializer / generator.
It creates or updates any kind (or part) of project from template(s)

USAGE:
    ffizer [FLAGS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Verbose mode (-v, -vv (very verbose / level debug), -vvv) print on stderr

SUBCOMMANDS:
    apply      Apply a template into a target directory
    help       Prints this message or the help of the given subcommand(s)
    inspect    Inspect configuration, caches,... (wip)
    upgrade    Self upgrade ffizer executable

Self upgrade the executable

➜  ffizer upgrade

Apply a template (to create or update)

➜  ffizer apply --help

ffizer-apply 1.6.0
https://github.com/ffizer/ffizer
Apply a template into a target directory

USAGE:
    ffizer apply [FLAGS] [OPTIONS] --destination <dst-folder> --source <uri>

FLAGS:
    -h, --help                      Prints help information
        --offline                   in offline, only local templates or cached templates are used
        --x-always_default_value    should not ask for valiables values, always use defautl value or empty
                                    (experimental)

OPTIONS:
        --confirm <confirm>               ask for plan confirmation [default: Never]  [possible values:
                                          Auto, Always, Never]
    -d, --destination <dst-folder>        destination folder (created if doesn't exist)
        --rev <rev>                       git revision of the template [default: master]
        --source-subfolder <subfolder>    path of the folder under the source uri to use for template
        --update-mode <update-mode>       mode to update existing file [default: Ask]  [possible values:
                                          Ask, Keep, Override, UpdateAsRemote,
                                          CurrentAsLocal, ShowDiff, Merge]
    -s, --source <uri>                    uri / path of the template

• use a local folder as template

  ffizer apply --source $HOME/my_templates/tmpl0 --destination my_project
  

• use a remote git repository as template

  ffizer apply --source https://github.com/ffizer/template_sample.git --destination my_project
  

  output

  Configure variables
  
  project_name: my_project
  
  
  Plan to execute
  
    - mkdir "my_project/"
    - mkdir "my_project/dir_1"
    - copyraw "my_project/dir_1/file_1_1.txt"
    - mkdir "my_project/dir_2_my_project"
    - copyraw "my_project/dir_2_my_project/file_1_2.txt"
    - copyraw "my_project/file_1.txt"
    - copyrender "my_project/file_2.txt"
    - keep "my_project/file_2.txt"
    - copyrender "my_project/file_3.txt"
    - copyraw "my_project/file_4_my_project.txt"
    - copyrender "my_project/file_5_my_project.txt"
    - copyraw "my_project/file_6.hbs"
  

Authoring a template

see Template Authoring - ffizer WIP

Templates

• Any git repositories (in this case ffizer is like git clone ...)
• Parametrized (with variables) templates:
  • ffizer/templates_default: the default collections of templates for ffizer (WIP)
  • davidB31 / cg-starter-multi-rust · GitLab Project template for Multi-Bot in Rust on CodinGame.
  • davidB/templates: repository to host the my collections of templates to used with ffizer.
  • github repo tagged ffizer-template
  • samples (used for test, demo) templates_default)
    • test_1
    • test_2 (demo of usage of gitignore.io)
    • ffizer/template_sample: a simple template for ffizer used for demo and test

Build

cargo install cargo-make --force
cargo make ci-flow

Update CHANGELOG.md

cargo make update-changelog
git add CHANGELOG.md
git commit -m ':memo: (CHANGELOG) update'

Release a new version by bump patch (or minoror major)

cargo make publish -- patch --dry-run
cargo make publish -- patch