Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Cargo-scaffold
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.
Features
- Scaffold a project in seconds
- Declarative
- User interactions automatically generated
- Not only for Rust crate/project. It's completely language agnostic
Installation
cargo install cargo-scaffold
Usage
You can scaffold your project from any cargo-template
scaffold located locally in a directory or in a git repository
# Locally
cargo scaffold your_template_dir
# From git repository
cargo scaffold https://github.com/username/template.git
# From git repository based on a specific commit
cargo scaffold https://github.com/username/template.git deed14dcbf17ba87f6659ea05755cf94cb1464ab
Here are the available options for cargo scaffold
:
USAGE:
cargo-scaffold scaffold [FLAGS] [OPTIONS] <template>
FLAGS:
-a, --append Append files in the existing directory, do not create directory with the project name
-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 <commit>
Full commit hash from which the template is cloned (i.e.: "deed14dcbf17ba87f6659ea05755cf94cb1464ab")
-n, --name <name>
Specify the name of your generated project (and so skip the prompt asking for it)
-d, --target-directory <target-directory> Specifiy the target directory
ARGS:
<template> Specifiy your template location
Write your own template
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.
Template description
Here is an example of .scaffold.toml
file:
# Basic template informations
[]
= "test"
= "Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>"
= "0.1.0"
# Exclude paths you do not want copy/pasted in the generated project
= [
"./target"
]
# Notes to display at the end of the generation
= """
Have fun using this template called {{name}} ! Here is the description: {{description}}
"""
[]
# Commands to be executed before scaffolding, from within the generated project
= [
"bash -c some_pre_script.sh"
]
# Commands to be executed after scaffolding, from within the generated project
= [
"cargo vendor",
"bash -c some_post_script.sh"
]
# Parameters are basically all the variables needed to generate your template using templating.
# It will be displayed as prompt to interact with user (thanks to the message subfield).
# All the parameters will be available in your templates as variables (example: `{{description}}`).
[]
# [parameters.name] is already reserved
[]
= "string"
= "What is the name of your feature ?"
= true
[]
= "select"
= "Which kind of API do you want to scaffold ?"
= ["REST", "graphql"]
[]
= "multiselect"
= "Which dependencies do you want to use ?"
= ["serde", "anyhow", "regex", "rand", "tokio"]
[]
= "string"
= "What is the description of your feature ?"
= "Here is my default description"
[]
= "boolean"
= "Do you want to display the description ?"
[]
= "integer"
= "What is the limit ?"
Here is the list of different types you can use for your parameter: string
, integer
, float
, boolean
, select
, multiselect
.
Templating
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.
{{#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}}.rs
would be generated with the right name).
Credits
Thanks @Arlune for this awesome logo and all reviewers.