guidon

guidon 基于 handlebars 模板系统进行模板处理。

用法

需要处理的文件需要有 .hbs 扩展名。文件夹和文件名也可以进行模板化： {{folder/subfolder}} 入口点是 Guidon 结构。

基本初始化

 let mut guidon = Guidon::new(PathBuf::from("path/to/template/dir"));
 let mut vars = BTreeMap::new();
 vars.insert("key1".to_string(), "value1".to_string());
 guidon.variables(vars);
 guidon.apply_template("path/to/destination").unwrap();

使用此初始化

• guidon 将使用 vars 映射来查找替换值。
• guidon 将解析目录 path/to/template/dir/template
• 结果将写入 path/to/destination

TryNew 初始化

guidon 实现了 TryNew 特性，可以从目录或 git 仓库进行初始化

从路径 TryNew

let mut guidon = Guidon::try_new("path/to/template/dir").unwrap();

使用此初始化

• guidon 将从 path/to/template/dir/variables.toml 初始化替换变量
• guidon 将解析目录 path/to/template/dir/template

let mut guidon = Guidon::try_new("path/to/template/dir/my_vars.toml").unwrap();

使用此初始化

• guidon 将从 path/to/template/dir/my_vars.toml 初始化替换变量
• guidon 将解析目录 path/to/template/dir

从 CustomTemplate TryNew

Guidon 可以提供特定的模板文件和目录进行解析。

let custom = CustomTemplate {
    dir_path: Path::new("path/to/template/dir"),
    template_path: Path::new("path/to/my_vars.toml")
};
let mut guidon = Guidon::try_new(custom);

从 Git 仓库 TryNew

let git = GitOptions::builder()
    .repo("url/to/repo")
    .build()
    .unwrap();
let mut guidon = Guidon::try_new(git);

使用此初始化

• guidon 将将仓库克隆到临时目录
• guidon 将从 tmp/dir/template.toml 初始化替换变量
• 在应用模板时，guidon 将解析目录 tmp/dir/template

Git仓库URL可以采用以下格式

• http[s]://[user[:password]]@uri/repo[.git] 其中 user 和 password 必须包含在URL中
• git@uri:repo.git。必须使用在 ssh-agent 实例中加载的密钥。

模板变量

配置文件的结构如下

# Key value pairs for template substitution
[variables]
test1 = "test 1"
test2 = "test 2"

辅助工具

• replace。它简单地用另一个字符串替换值。 Tell me: {{replace my_var everybody world}} 与 my_var="Hello everybody ! 将渲染为 Tell me: Hello world !。
• append。简单地将字符串附加到值上。 Tell me: {{append my_var "and everybody !"}} 与 my_var="Hello world" 将渲染为 Tell me: Hello world and everybody !。
• prepend。将字符串添加到值之前。 Tell me: {{prepend my_var "Sure, "}} 与 my_var="hello world" 将渲染为 Tell me: Sure, hello world。
• up：将值转换为大写
• low：将值转换为小写
• default：如果输入为null或空，则默认为给定值 Tell me: {{default my_var "Oops"}} 与 my_var 未定义将渲染为 Tell me: Oops
• encrypt：加密数据。必须提供密钥
• decrypt：解密数据

let cb = |h: &mut BTreeMap<String, String>| {
        h.iter_mut().for_each(|(_, v)|  *v +=" cb");
};
let mut guidon = Guidon::new(PathBuf::from("template/path"));
guidon.set_variables_callback(cb);

// this callback will add `-cb` to the key as a value
let cb = |h: String| {
        let mut s = h.clone();
        s.push_str("-cb");
        s
 };
let mut guidon = Guidon::new(PathBuf::from("template/path"));
guidon.set_render_callback(cb);