Crate string_template_plus

source ·
Expand description

Introduction

This is a simple template tool that works with variable names and HashMap of String. The Template can be parsed from str and then you can render it using the variables in HashMap and any shell commands running through Exec.

Features

  • Parse the template from a str that’s easy to write,
  • Support for alternatives in case some variables are not present, Use ? to separate the alternatives, uses whichever it can find first. If ? is at the end, leaves it blank instead of erroring out.
  • Support for literal strings inside the alternative options, You can use a literal string "string" enclosed in " as an alternative if you want to put something instead of blank at the end.
  • Support for the date time format using chrono, You can use any format starting with % inside the variable placeholder {} to use a date time format supported by chrono.
  • Support for any arbitrary commands, etc. You can keep any command inside $( and ) to run it and use the result in the template. You can use other format elements inside it.

Usages

Simple variables:

let templ = parse_template("hello {name}").unwrap();
let mut vars: HashMap<String, String> = HashMap::new();
vars.insert("name".into(), "world".into());
let rendered = templ
.render(&RenderOptions {
variables: vars,
..Default::default()
            })
            .unwrap();
assert_eq!(rendered, "hello world");

Safe replace, blank if not present, or literal string if not present:

let templ = parse_template("hello {name?} {lastname?\"User\"}").unwrap();
let vars: HashMap<String, String> = HashMap::new();
let rendered = templ
.render(&RenderOptions {
variables: vars,
..Default::default()
            })
            .unwrap();
assert_eq!(rendered, "hello  User");

Alternate, whichever variable it finds first will be replaced:

let templ = parse_template("hello {nickname?name}").unwrap();
let mut vars: HashMap<String, String> = HashMap::new();
vars.insert("name".into(), "world".into());
let rendered = templ
.render(&RenderOptions {
variables: vars,
..Default::default()
            })
            .unwrap();
        assert_eq!(rendered, "hello world");

Custom Commands:

let templ = parse_template("L=$(printf \"%.2f\" {length})").unwrap();
let mut vars: HashMap<String, String> = HashMap::new();
vars.insert("length".into(), "12.342323".into());
let rendered = templ
.render(&RenderOptions {
wd: PathBuf::from("."),
variables: vars,
shell_commands: true,
            })
            .unwrap();
        assert_eq!(rendered, "L=12.34");

You can turn off Custom Commands for safety:

let templ = parse_template("L=$(printf \"%.2f\" {length})").unwrap();
let mut vars: HashMap<String, String> = HashMap::new();
vars.insert("length".into(), "12.342323".into());
let rendered = templ
.render(&RenderOptions {
wd: PathBuf::from("."),
variables: vars,
shell_commands: false,
            })
            .unwrap();
        assert_eq!(rendered, "L=$(printf \"%.2f\" 12.342323)");

Date Time:

let templ = parse_template("hello {name} at {%Y-%m-%d}").unwrap();
let timefmt = Local::now().format("%Y-%m-%d");
let output = format!("hello world at {}", timefmt);
let mut vars: HashMap<String, String> = HashMap::new();
vars.insert("name".into(), "world".into());
let rendered = templ
.render(&RenderOptions {
wd: PathBuf::from("."),
variables: vars,
shell_commands: false,
            })
            .unwrap();
        assert_eq!(rendered, output);

Limitations

  • You cannot use positional arguments in this template system, only named ones. {} will be replaced with empty string. Although you can use "0", "1", etc as variable names in the template and the render options variables.
  • I haven’t tested variety of names, although they should work try to keep the names identifier friendly.
  • Currently doesn’t have format specifiers, for now you can use the command options with printf bash command to format things the way you want. Like a template this is $(printf "%.2f" {weight}) kg. should be rendered with the correct float formatting.

Structs

  • RenderIter
    Render option with Iterator support. You can use this to get incremented render results. It’ll add -N to the render Template where N is the count (1,2,3…). It can be useful to make files with a given template.
  • RenderOptions
    Options for the Template to render into String
  • SHELL_COMMAND_REGEX
    Regex to capture the Shell Command part in the template
  • VARIABLE_REGEX
    Regex to capture the variable from the template, anything inside {}

Enums

Statics

  • LITERAL_VALUE_QUOTE_CHAR
    Quote characters to use to make a value literal instead of a variable. In combination with OPTIONAL_RENDER_CHAR it can be used as a default value when variable(s) is/are not present.
  • OPTIONAL_RENDER_CHAR
    Character to separate the variables. If the first variable is not present it’ll use the one behind it and so on. Keep it at the end, if you want a empty string instead of error on missing variable.
  • TIME_FORMAT_CHAR
    Character that should be in the beginning of the variable to determine it as datetime format.

Traits

Functions

  • parse_template
    Parses the template from string and makes a Template. Which you can render later./// Main Template that get’s passed around, consists of [Vec] of TemplatePart

Type Aliases