readmer 0.0.5

Compose README.md files from Liquid or Jinja2 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

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

use crate::Utf8Path;
use alloc::string::String;
use figment2::{
    Figment,
    providers::{Env, Format, Yaml},
};
use serde::{Deserialize, Serialize};
use serde_json::Value;

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Project {
    /// The project label.
    pub label: String,

    /// The project title.
    pub title: String,

    /// The project summary.
    pub summary: String,
}

impl Project {
    pub fn load(path: impl AsRef<Utf8Path>) -> Result<Self, figment2::Error> {
        Figment::new()
            .merge(Yaml::file(path.as_ref()))
            .merge(Env::prefixed("READMER_"))
            .extract()
    }

    pub fn to_json(&self) -> Value {
        self.clone().into_json()
    }

    pub fn into_json(self) -> Value {
        serde_json::to_value(self).unwrap()
    }
}