readmer 0.0.3

Compose README.md files from Jinja2 or Liquid templates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

// This is free and unencumbered software released into the public domain.

use crate::{Context, Engine, RenderError, Utf8Path, Utf8PathBuf};
use alloc::{
    boxed::Box,
    string::{String, ToString},
};
use minijinja::{Environment, Error, UndefinedBehavior};

#[derive(Clone, Debug)]
pub struct MinijinjaEngine(Environment<'static>);

impl Default for MinijinjaEngine {
    fn default() -> Self {
        Self::new()
    }
}

impl MinijinjaEngine {
    pub fn new() -> Self {
        let mut env = Environment::new();
        env.set_undefined_behavior(UndefinedBehavior::Strict);
        Self(env)
    }
}

impl Engine for MinijinjaEngine {
    fn define_template(
        &mut self,
        name: String,
        data: String,
    ) -> Result<(), Box<dyn core::error::Error>> {
        let env = &mut self.0;
        env.add_template_owned(name, data)?;
        Ok(())
    }

    fn render(&mut self, name: String, context: Box<dyn Context>) -> Result<String, RenderError> {
        let env = &mut self.0;
        let template = env.get_template(name.as_ref())?;
        let mut output = template.render(context.to_json())?;
        output.push('\n'); // ensure newline-termination
        Ok(output)
    }
}