ferrous_forge/lib.rs
1//! # Ferrous Forge
2//!
3//! The Type-Safe Rust Development Standards Enforcer
4//!
5//! Ferrous Forge is a comprehensive system-wide tool that automatically enforces
6//! professional Rust development standards across all projects on your machine.
7//!
8//! ## Features
9//!
10//! - Zero underscore bandaid coding enforcement
11//! - Edition 2024 automatic upgrades
12//! - System-wide cargo command hijacking
13//! - Automatic project template injection
14//! - Real-time code validation
15//! - Professional CI/CD setup
16//!
17//! ## Quick Start
18//!
19//! ```bash
20//! cargo install ferrous-forge
21//! ferrous-forge init
22//! cargo new my-project # Now follows all standards automatically
23//! ```
24//!
25//! ## Modules
26//!
27//! - [`cli`] - Command line interface definitions
28//! - [`commands`] - Command implementations
29//! - [`config`] - Configuration management
30//! - [`standards`] - Standards definitions and enforcement
31//! - [`templates`] - Project template system
32//! - [`validation`] - Code validation and linting
33//! - [`updater`] - Self-update and version management
34
35#![forbid(unsafe_code)]
36#![warn(missing_docs)]
37#![cfg_attr(docsrs, feature(doc_cfg))]
38
39pub mod cli;
40pub mod commands;
41pub mod config;
42pub mod doc_coverage;
43pub mod edition;
44pub mod error;
45pub mod formatting;
46pub mod git_hooks;
47pub mod rust_version;
48pub mod security;
49pub mod standards;
50pub mod templates;
51pub mod test_coverage;
52pub mod updater;
53pub mod validation;
54
55// Re-export commonly used types
56pub use crate::config::Config;
57pub use crate::error::{Error, Result};
58
59/// Current version of Ferrous Forge
60pub const VERSION: &str = env!("CARGO_PKG_VERSION");
61
62/// Minimum supported Rust version
63pub const MIN_RUST_VERSION: &str = "1.82.0";
64
65/// Edition enforced by Ferrous Forge
66pub const REQUIRED_EDITION: &str = "2024";