ebg 0.7.0

Eric's Blog Generator, a simple static site generator.
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

//! This module provides machinery for collecting and reporting diagnostics that
//! arise during site generation.
//!
//! It builds heavily on the `miette` crate.

use miette::{Diagnostic, IntoDiagnostic};
use thiserror::Error;
use tracing::debug;

pub struct DiagnosticContext {
    diagnostics: Vec<miette::Report>,
    any_errors: bool,
}

impl DiagnosticContext {
    pub fn with<T, E, R>(f: impl FnOnce(&mut Self) -> R) -> Result<T, ErrorSet>
    where
        R: IntoDiagnostic<T, E>,
    {
        let mut this = Self {
            diagnostics: Vec::new(),
            any_errors: false,
        };

        match f(&mut this).into_diagnostic() {
            Ok(value) => {
                if this.any_errors {
                    return Err(ErrorSet {
                        errors: this.diagnostics,
                    });
                };
                if !this.diagnostics.is_empty() {
                    debug!("generating report for {} warnings", this.diagnostics.len());
                    let warnings = WarningSet {
                        warnings: this.diagnostics,
                    };
                    let warnings = miette::Report::new(warnings);
                    eprintln!("{:?}", warnings);
                }
                Ok(value)
            }
            Err(error) => {
                this.record_report(error);
                Err(ErrorSet {
                    errors: this.diagnostics,
                })
            }
        }
    }

    // FIXME: this method should be pulled into a trait so I can implement it
    // for RenderContext as well.

    pub fn record(&mut self, diagnostic: impl Diagnostic + Send + Sync + 'static) {
        self.record_report(miette::Report::new(diagnostic))
    }

    fn record_report(&mut self, report: miette::Report) {
        debug!("recording diagnostic: {}", report);
        if <_ as AsRef<(dyn Diagnostic + 'static)>>::as_ref(&report)
            .severity()
            .unwrap_or(miette::Severity::Error)
            >= miette::Severity::Error
        {
            self.any_errors = true;
        }

        self.diagnostics.push(report);
    }
}

/// A collection of errors and warnings that occured while running code under a
/// [`DiagnosticContext`].
#[derive(Diagnostic, Error, Debug)]
#[error("Errors and warnings")]
#[diagnostic(severity(error))]
pub struct ErrorSet {
    #[related]
    errors: Vec<miette::Report>,
}

impl ErrorSet {
    pub fn iter(&self) -> impl Iterator<Item = &miette::Report> {
        self.errors.iter()
    }
}

#[derive(Diagnostic, Error, Debug)]
#[error("Warnings")]
#[diagnostic(severity(warning))]
struct WarningSet {
    #[related]
    warnings: Vec<miette::Report>,
}