Builtin placeholders
cargo-generate supports a number of builtin placeholders for use in templates.
These placeholders can be used directly in files using the Liquid language, or from
Rhai scripts using the syntax: variable::get("placeholder name").
The current supported builtin placeholders are:
-
{{authors}}this will be filled in by a function borrowed from Cargo's source code, that determines your information from Cargo's configuration. It will either be on the form
username <email>or just plainusername. -
{{project-name}}this is supplied by either passing the
--nameflag to the command or working with the interactive CLI to supply a name. -
{{crate_name}}the snake_case_version of
project-name -
{{crate_type}}this is supplied by either passing the
--binor--libflag to the command line, contains eitherbinorlib,--binis the default -
{{os-arch}}contains the current operating system and architecture ex:
linux-x86_64 -
{{username}}this will be filled in by a function borrowed from Cargo's source code, that determines your information from Cargo's configuration.
-
{{within_cargo_project}}A boolean with the value
trueif the template is being expanded inside aCargoproject. It's a simple matter of whetherCargo.tomlis present in any parent folder. -
{{is_init}}A boolean that reflects the value of the
--initparameter ofcargo-generate.