scaffold-rs

An opinionated Rust project template for cargo generate that provides a robust foundation for both library and binary crates. This template extends rust-github/template with additional structure and features to support a wide range of development use cases - from simple utilities to complex applications with async capabilities, configuration management, and structured error handling.

Please review ARCHITECTURE.md for details about this template.

Enhancements

• Structured test organization: with examples of unit, integration, and doc tests
• Pre-commit hooks: for code quality enforcement
• Rust version explicit: specification via .rust-version file
• Modern Error Handling: Built-in thiserror and anyhow integration with error type definitions
• Command-Line Argument Parsing: Ready-to-use CLI setup with clap derive feature
• Configuration Management: Flexible config system (config, serde) with environment variable support
• Structured Logging: Preconfigured tracing setup for production-ready logging
• Convenient Makefile: Common commands for build, test, lint, and documentation
• Async Support: Optional tokio runtime integration for asynchronous applications
• Time Handling: Date/time utilities with chrono integration
• Feature Flags: Conditional compilation for optional components like async and time utilities
• GitHub Actions: Sufficient workflows for testing, linting, coverate, and security auditing

Usage

Install cargo-generate if you don't have it already:

cargo install cargo-generate

Generate a new project:

cargo generate --git https://github.com/cdvel/scaffold-rs

Follow the prompts to configure your project.

Available Template Options

• Project type: Binary or library
• GitHub username: For repository links and documentation
• Project description: For Cargo.toml and documentation

License

MIT