ferrous-forge 1.9.6

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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! Type definitions for Rust coding standards

use serde::{Deserialize, Serialize};

/// Rust coding standards enforced by Ferrous Forge
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CodingStandards {
    /// Rust edition requirements
    pub edition: EditionStandards,
    /// File size limits
    pub file_limits: FileLimits,
    /// Function size limits
    pub function_limits: FunctionLimits,
    /// Documentation requirements
    pub documentation: DocumentationStandards,
    /// Banned patterns and practices
    pub banned_patterns: BannedPatterns,
    /// Dependency requirements
    pub dependencies: DependencyStandards,
    /// Security requirements
    pub security: SecurityStandards,
}

/// Rust edition requirements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EditionStandards {
    /// Required Rust edition
    pub required_edition: String,
    /// Minimum Rust version
    pub min_rust_version: String,
    /// Whether to automatically upgrade projects
    pub auto_upgrade: bool,
}

/// File size limits
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FileLimits {
    /// Maximum lines per file
    pub max_lines: usize,
    /// Maximum characters per line
    pub max_line_length: usize,
    /// Files that are exempt from size limits
    pub exempt_files: Vec<String>,
}

/// Function size limits
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FunctionLimits {
    /// Maximum lines per function
    pub max_lines: usize,
    /// Maximum cyclomatic complexity
    pub max_complexity: usize,
    /// Functions that are exempt from size limits
    pub exempt_functions: Vec<String>,
}

/// Documentation requirements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DocumentationStandards {
    /// Require documentation for public items
    pub require_public_docs: bool,
    /// Require documentation for private items
    pub require_private_docs: bool,
    /// Minimum documentation coverage percentage
    pub min_coverage: f64,
    /// Require examples in documentation
    pub require_examples: bool,
}

/// Banned patterns and practices
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BannedPatterns {
    /// Ban `unwrap()` in production code
    pub ban_unwrap: bool,
    /// Ban `expect()` in production code
    pub ban_expect: bool,
    /// Ban panic!() in production code
    pub ban_panic: bool,
    /// Ban todo!() in production code
    pub ban_todo: bool,
    /// Ban unimplemented!() in production code
    pub ban_unimplemented: bool,
    /// Ban underscore variable names as error handling bandaids
    pub ban_underscore_bandaid: bool,
    /// Custom banned patterns
    pub custom_patterns: Vec<BannedPattern>,
}

/// A custom banned pattern
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BannedPattern {
    /// Pattern name
    pub name: String,
    /// Regular expression to match
    pub pattern: String,
    /// Error message to display
    pub message: String,
    /// Severity level (error, warning, info)
    pub severity: String,
}

/// Dependency requirements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DependencyStandards {
    /// Maximum number of dependencies
    pub max_dependencies: usize,
    /// Require license checking
    pub require_license_check: bool,
    /// Banned licenses
    pub banned_licenses: Vec<String>,
    /// Required MSRV compatibility
    pub require_msrv_compatible: bool,
}

/// Security requirements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SecurityStandards {
    /// Ban unsafe code
    pub ban_unsafe: bool,
    /// Require security audit
    pub require_audit: bool,
    /// Maximum allowed CVE score
    pub max_cve_score: f64,
}