Expand description
§Ferrous Forge
The Type-Safe Rust Development Standards Enforcer
Ferrous Forge is a comprehensive system-wide tool that automatically enforces professional Rust development standards across all projects on your machine.
§Features
- Zero underscore bandaid coding enforcement
- Edition 2024 automatic upgrades
- System-wide cargo command hijacking
- Automatic project template injection
- Real-time code validation
- Professional CI/CD setup
§Quick Start
use ferrous_forge::{Config, Result};
#[tokio::main]
async fn main() -> Result<()> {
// Load or create default configuration
let config = Config::load_or_default().await?;
println!("Ferrous Forge v{}", ferrous_forge::VERSION);
println!("Required edition: {}", config.required_edition);
Ok(())
}§CLI Usage
cargo install ferrous-forge
ferrous-forge init
cargo new my-project # Now follows all standards automatically§Modules
§Core
cli— Command line interface definitions and argument parsingcommands— Implementation of all Ferrous Forge commandsconfig— Configuration management and hierarchical config systemerror— Error types and result handling
§Standards & Validation
standards— Development standards definitions and enforcementvalidation— Core validation logic and rule enforcementsafety— Safety pipeline and enforcement mechanismsformatting— Code formatting enforcement and validation
§Rust Ecosystem
edition— Rust edition management and upgrade assistancerust_version— Rust version checking and compatibility validationdoc_coverage— Documentation coverage checking and reportingsecurity— Security auditing and vulnerability scanningtest_coverage— Test coverage integration and reporting
§Tooling
templates— Project template system and built-in templatesgit_hooks— Git hooks installation and managementcargo_intercept— Cargo command interception for publish validationupdater— Self-update functionality and version management
§Analysis
ai_analyzer— AI-powered violation analysis and fix suggestionsperformance— Performance optimizations for validation
Re-exports§
Modules§
- ai_
analyzer - AI-powered violation analysis and fix suggestions AI analysis module for automated violation analysis
- cargo_
intercept - Cargo command interception for publish validation Cargo publish interception system
- cli
- Command line interface definitions and argument parsing Command Line Interface for Ferrous Forge
- commands
- Implementation of all Ferrous Forge commands Command implementations for Ferrous Forge
- config
- Configuration management and hierarchical config system Configuration management for Ferrous Forge
- doc_
coverage - Documentation coverage checking and reporting Documentation coverage checking module
- edition
- Rust edition management and upgrade assistance Rust edition detection and migration assistance
- error
- Error types and result handling Error handling for Ferrous Forge
- formatting
- Code formatting enforcement and validation Code formatting and auto-correction module
- git_
hooks - Git hooks installation and management Git hooks installation and management
- performance
- Performance optimizations for validation Performance optimizations for Ferrous Forge
- rust_
version - Rust version checking and compatibility validation Rust version management and checking
- safety
- Safety pipeline and enforcement mechanisms Enhanced Safety Pipeline for Ferrous Forge
- security
- Security auditing and vulnerability scanning Security audit integration module
- standards
- Development standards definitions and enforcement Rust coding standards definitions and enforcement
- templates
- Project template system and built-in templates Template System 2.0 - Project templates with Ferrous Forge standards built-in
- test_
coverage - Test coverage integration and reporting Test coverage module - now modularized for better organization
- updater
- Self-update functionality and version management Self-update system for Ferrous Forge
- validation
- Core validation logic and rule enforcement Rust code validation engine
Constants§
- MIN_
RUST_ VERSION - Minimum supported Rust version
- REQUIRED_
EDITION - Edition enforced by Ferrous Forge
- VERSION
- Current version of Ferrous Forge