Scaficionado

Pronunciation: ska·fi·ci·o·na·do, or scaffold + aficionado.

A scaffolding tool to create repeatable project structure using files and scripts from local or remote repositories.

• Files ending in .tera will get templated using tera, otherwise they'll just get copied.
• Files will get generated into a directory called "generated" in the root of where it's called.
• Hooks (shell scripts) can be called before and after each scaffold

Status

Prerequisites

• A scaffolding.toml file (can be renamed if using -c argument). See Configuration Details below.

Install

cargo install scaficionado

Usage

scaficionado -h
# Usage: scaficionado [OPTIONS]

# Options:
#   -p, --project-name <PROJECT_NAME>  The name of the project to scaffold.  Overwrites project_name set in configuration file [default: MyExampleProject]
#   -o, --output <OUTPUT>              The output directory where the generated files will be placed.  Overwrites output set in configuration file [default: generated]
#   -c, --config <CONFIG>              The configuration file path [default: scaffolding.toml]
#   -w, --overwrite                    Overwrite existing files if set. [default: false].  Overwrites overwrite=false set in configuration file
#   -h, --help                         Print help
#   -V, --version                      Print version

# accept defaults
scaficionado

# with flags for project name and output
scaficionado -p MyTestProjectName -o output_scaffolding

# force overwrite existing files in current working directory
scaficionado -p MyTestProjectName -o . -w

Configuration Details

# (optional) project section, defining name, output location, overwrite which can alternatively be specified as command-line arguments.
[project]

# (optional) project name.  Overwrites the default project_name.  Overwritten by the project-name command-line argument.
name = "MyExampleProject"

# Overwrites the default output directory.  Overwritten by the output command-line argument.
# Warning: will overwrite files in your current working directory if you use "."
# e.g. "output" or "." for current directory
output = "generated"

# (optional) Controls whether or not existing files are overwritten.  Defaults to false.
overwrite = false

# Array of scaffolds
# Each [[scaffolds]] entry defines a separate scaffold. The generator processes each scaffold in order.
[[scaffolds]]

# A friendly name for the scaffold (used for logging), which has no bearing on the configuration
name = 

# The repository from which to pull the scaffold files. This can be either a local path (e.g. ../example-1) or a remote Git URL.
repo =

# The directory within the repository that contains your templates. Defaults to "templates" if not provided.
# For repositories where the files reside at the root, set this to ".".
# (optional): defaults to "templates" if not provided.
template_dir = "."

# Under the template table, list the files to process. Each file entry has a src and dest, and dest paths can use the {{project_name}} variable.
[scaffolds.template]
files = [
    {src = "src1.ext.tera", dest = "dest1/src1.ext"},
    {src = "src2.ext", dest = "dest2/src2.ext"},
    {src = "src3.ext", dest = "{{project_name}}-{{some_count}}/dest3/src3.ext"},
]

# Optionally specify hook scripts to run before (pre) and after (post) template rendering. These paths are relative to the repository root.
[scaffolds.hooks]
# optional pre hook found in the remote repository
pre = "hooks/pre.sh"
# optional post hook found in the remote repository
post = "hooks/post.sh"

# Optionally specify key/values to get injected into the context
[scaffolds.variables]
some_count = 2
some_environment = "development"

Expanded variables

Expanded variables apply to the dest section of the scaffold, as well as the expanded tera templated file.

• project_name: if used in scaffolding.toml, this path will get expanded (e.g. scaficionado -n TestProjectOne)
• key/values defined under scaffolds.variables (e.g. {{some_count}}) would expand to 2 in the above example

Example configuration

• example scaffolding for Kubernetes
• example scaffolding for Rust AI app

Build from source

cargo build --release
cargo install --path .

Release

To release a new version to Crates.io, tag a new version as vX.Y.Z, matching the version in Cargo.toml.