ferrous-forge 1.9.4

System-wide Rust development standards enforcer
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

//! Safety check implementations
//!
//! This module contains individual check implementations for the safety pipeline.
//! Each check module implements a specific validation (format, clippy, tests, etc.)

use crate::Result;
use std::path::Path;

use super::report::CheckResult;

/// Dependency vulnerability auditing via `cargo audit`.
pub mod audit;
/// Build verification check.
pub mod build;
/// Clippy lint analysis check.
pub mod clippy;
/// Documentation generation and coverage check.
pub mod doc;
/// Code formatting verification via `rustfmt`.
pub mod format;
/// License compliance validation.
pub mod license;
/// Publish readiness verification for crates.io.
pub mod publish;
/// Semver compatibility check for public API changes.
pub mod semver;
/// Ferrous Forge coding standards enforcement.
pub mod standards;
/// Test suite execution and result validation.
pub mod test;
/// Test runner infrastructure for safety checks.
pub mod test_runner;

/// Trait for implementing safety checks
#[allow(async_fn_in_trait)]
pub trait SafetyCheck {
    /// Run the safety check
    async fn run(project_path: &Path) -> Result<CheckResult>;

    /// Get the name of this check
    fn name() -> &'static str;

    /// Get a description of what this check does
    fn description() -> &'static str;
}

/// Registry of all available safety checks
pub struct CheckRegistry;

impl CheckRegistry {
    /// Get all available check types
    pub fn all_checks() -> Vec<super::CheckType> {
        vec![
            super::CheckType::Format,
            super::CheckType::Clippy,
            super::CheckType::Build,
            super::CheckType::Test,
            super::CheckType::Audit,
            super::CheckType::Doc,
            super::CheckType::PublishDryRun,
            super::CheckType::Standards,
            super::CheckType::DocCoverage,
            super::CheckType::License,
            super::CheckType::Semver,
        ]
    }

    /// Get description for a check type
    pub fn get_description(check_type: super::CheckType) -> &'static str {
        match check_type {
            super::CheckType::Format => "Validates code formatting with rustfmt",
            super::CheckType::Clippy => "Runs clippy lints with strict warnings",
            super::CheckType::Build => "Ensures project builds successfully",
            super::CheckType::Test => "Runs the complete test suite",
            super::CheckType::Audit => "Scans for security vulnerabilities",
            super::CheckType::Doc => "Builds project documentation",
            super::CheckType::PublishDryRun => "Validates crates.io publication",
            super::CheckType::Standards => "Validates Ferrous Forge standards",
            super::CheckType::DocCoverage => "Checks documentation coverage",
            super::CheckType::License => "Validates license compatibility",
            super::CheckType::Semver => "Checks semantic versioning compliance",
        }
    }
}