normalize-native-rules 0.3.2

Native rule checks for normalize (stale-summary, check-refs, stale-docs, check-examples)
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

//! Native rule integration for the ratchet system.
//!
//! Delegates to `normalize_ratchet::service::build_ratchet_diagnostics`.

use normalize_output::OutputFormatter;
use normalize_output::diagnostics::DiagnosticsReport;
use serde::Serialize;
use std::path::Path;

/// Report returned by the ratchet native rule check.
///
/// Wraps the `DiagnosticsReport` produced by the ratchet service so that it
/// can be formatted standalone (as text) or converted to a `DiagnosticsReport`
/// for the rules engine.
#[derive(Debug, Serialize, schemars::JsonSchema)]
pub struct RatchetRulesReport(pub DiagnosticsReport);

impl OutputFormatter for RatchetRulesReport {
    fn format_text(&self) -> String {
        self.0.format_text()
    }

    fn format_pretty(&self) -> String {
        self.0.format_pretty()
    }
}

impl From<RatchetRulesReport> for DiagnosticsReport {
    fn from(report: RatchetRulesReport) -> Self {
        report.0
    }
}

/// Build a RatchetRulesReport from the ratchet baseline check.
///
/// Called by the native rules engine. Returns an empty report if no baseline
/// exists or the check succeeds.
pub fn build_ratchet_report(root: &Path) -> RatchetRulesReport {
    let factory: normalize_ratchet::MetricFactory = normalize_ratchet::default_metrics;
    RatchetRulesReport(normalize_ratchet::service::build_ratchet_report(
        root, &factory,
    ))
}