repolens 1.4.0

A CLI tool to audit and prepare repositories for open source or enterprise standards
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

//! Output formatting module for CLI

pub mod csv;
mod html;
pub mod json;
pub(crate) mod junit;
mod markdown;
pub mod ndjson;
mod pdf;
mod sarif;
mod terminal;

pub use csv::CsvOutput;
pub use html::HtmlReport;
pub use json::JsonOutput;
pub(crate) use junit::render_findings as render_junit_findings;
pub use junit::JunitReport;
pub use markdown::MarkdownReport;
pub use ndjson::NdjsonOutput;
pub use pdf::PdfReport;
pub use sarif::SarifOutput;
pub use terminal::TerminalOutput;

use crate::actions::plan::ActionPlan;
use crate::error::RepoLensError;
use crate::rules::results::AuditResults;

/// Trait for rendering plan output
pub trait OutputRenderer {
    fn render_plan(
        &self,
        results: &AuditResults,
        plan: &ActionPlan,
    ) -> Result<String, RepoLensError>;
}

/// Trait for rendering report output
pub trait ReportRenderer {
    fn render_report(&self, results: &AuditResults) -> Result<String, RepoLensError>;
}