cargo-scaffold is a flexible and easy-to-use developper tool to let you scaffold a project. It's fully configurable without writing any line of code. It generates any kind of projects with a developer friendly CLI.
bash
cargo install cargo-scaffold
You can scaffold your project from any cargo-template scaffold located locally in a directory or in a git repository
```bash
cargo scaffold yourtemplatedir
cargo scaffold https://github.com/username/template.git
cargo scaffold https://github.com/username/template.git deed14dcbf17ba87f6659ea05755cf94cb1464ab ```
Here are the available options for cargo scaffold:
```text USAGE: cargo-scaffold scaffold [FLAGS] [OPTIONS]
FLAGS: -a, --append Append files in the target directory, create directory with the project name if it doesn't already exist but doesn't overwrite existing file (use force for that kind of usage) -f, --force Override target directory if it exists -h, --help Prints help information -p, --passphrase Specify if your SSH key is protected by a passphrase -V, --version Prints version information
OPTIONS:
-c, --commit
-n, --name <name>
Specify the name of your generated project (and so skip the prompt asking for it)
-k, --private_key_path <private-key-path>
Specify if your private SSH key is located in another location than $HOME/.ssh/id_rsa
-r, --path <repository_template_path>
Specifiy your template location in the repository if it's not located at the root of your repository
-d, --target-directory <target-directory> Specifiy the target directory
ARGS: Specifiy your template location
```
To let you scaffold and generate different projects the only mandatory part is to have a .scaffold.toml file at the root of the template directory. This file is used to document and add user interactions for your template. In your template's directory each files and directories will be copy/pasted to your generated project but updated using Handlebars templating.
Here is an example of .scaffold.toml file:
```toml
[template] name = "test" author = "Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>" version = "0.1.0"
exclude = [ "./target" ]
notes = """ Have fun using this template called {{name}} ! Here is the description: {{description}} """
[hooks]
pre = [ "bash -c someprescript.sh" ]
post = [ "cargo vendor", "bash -c somepostscript.sh" ]
{{description}}).[parameters] # [parameters.name] is already reserved [parameters.feature] type = "string" message = "What is the name of your feature ?" required = true
[parameters.gender]
type = "select"
message = "Which kind of API do you want to scaffold ?"
values = ["REST", "graphql"]
[parameters.dependencies]
type = "multiselect"
message = "Which dependencies do you want to use ?"
values = ["serde", "anyhow", "regex", "rand", "tokio"]
[parameters.description]
type = "string"
message = "What is the description of your feature ?"
default = "Here is my default description"
[parameters.show_description]
type = "boolean"
message = "Do you want to display the description ?"
[parameters.limit]
type = "integer"
message = "What is the limit ?"
```
Here is the list of different types you can use for your parameter: string, integer, float, boolean, select, multiselect.
In any files inside your template's directory you can use Handlebars templating. Please refer to that documentation for all the syntax about templating. If you're looking for custom helpers in Handlerbars you can check the documentation here. Here is a basic example if you want to display the parameter named description and if the boolean parameter show_description is set to true as described in the previous section.
text
{{#if show_description}} {{description}} {{/if}}
{{#forRange 5}}
Repeat this line 5 times with the current {{@index}}{{/forRange}}
You can also put templating in path for directory or filename into your template (example: a file called
{{name}}.rswould be generated with the right name).
Thanks @Arlune for this awesome logo and all reviewers.