Struct AuditRunner 

pub struct AuditRunner { /* private fields */ }

Orchestrates dispatch across the 15 registered gates.

Implementations

impl AuditRunner

pub fn new(config: AuditConfig) -> Self

Constructs a runner with the 15 built-in gates registered.

Examples

use ssg::audit::{AuditConfig, AuditRunner};
let r = AuditRunner::new(AuditConfig::new());
assert_eq!(r.gate_names().len(), 15);

pub fn with_gates(config: AuditConfig, gates: Vec<Box<dyn AuditGate>>) -> Self

Constructs a runner with a user-supplied gate list (for tests).

Examples

use ssg::audit::{AuditConfig, AuditRunner};
let r = AuditRunner::with_gates(AuditConfig::new(), Vec::new());
assert!(r.gate_names().is_empty());

pub fn gate_names(&self) -> Vec<&'static str>

Returns the names of every gate registered with the runner.

Examples

use ssg::audit::{AuditConfig, AuditRunner};
let r = AuditRunner::new(AuditConfig::new());
assert!(r.gate_names().contains(&"wcag"));

pub fn run(&self, site: &Site) -> AuditReport

Runs every (enabled) gate sequentially and collects the result.

Examples

use std::path::PathBuf;
use ssg::audit::{AuditConfig, AuditRunner, Site};
let runner = AuditRunner::new(AuditConfig::new());
let site = Site { root: PathBuf::from("/nonexistent"), html_files: Vec::new() };
let report = runner.run(&site);
assert_eq!(report.len(), 15);

pub const fn fail_on(&self) -> Severity

Returns the configured fail_on threshold.

Examples

use ssg::audit::{AuditConfig, AuditRunner, Severity};
let r = AuditRunner::new(AuditConfig::new());
assert_eq!(r.fail_on(), Severity::Error);

Trait Implementations

impl Debug for AuditRunner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.