mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-30 21:53:28 +08:00
* feat(rules): add Rust coding style, hooks, and patterns rules Add language-specific rules for Rust extending the common rule set: - coding-style.md: rustfmt, clippy, ownership idioms, error handling, iterator patterns, module organization, visibility - hooks.md: PostToolUse hooks for rustfmt, clippy, cargo check - patterns.md: trait-based repository, newtype, enum state machines, builder, sealed traits, API response envelope Rules reference existing rust-patterns skill for deep content. Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering> * feat(rules): add Rust testing and security rules Add remaining Rust language-specific rules: - testing.md: cargo test, rstest parameterized tests, mockall mocking with mock! macro, tokio async tests, cargo-llvm-cov coverage - security.md: secrets via env vars, parameterized SQL with sqlx, parse-don't-validate input validation, unsafe code audit requirements, cargo-audit dependency scanning, proper HTTP error status codes Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering> * fix(rules): address review feedback on Rust rules Fixes from Copilot, Greptile, Cubic, and CodeRabbit reviews: - Add missing imports: use std::borrow::Cow, use anyhow::Context - Use anyhow::Result<T> consistently (patterns.md, security.md) - Change sqlx placeholder from ? to $1 (Postgres is most common) - Remove Cargo.lock from hooks.md paths (auto-generated file) - Fix tokio::test to show attribute form #[tokio::test] - Fix mockall mock! name collision, wrap in #[cfg(test)] mod tests - Fix --test target to match file layout (api_test, not integration) Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering> * fix: update catalog counts in README.md and AGENTS.md Update documented counts to match actual repository state after rebase: - Skills: 109 → 113 (new skills merged to main) - Commands: 57 → 58 (new command merged to main) Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering> --------- Co-authored-by: Chris Yau <chris@diveanddev.com> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Happy <yesreply@happy.engineering>
169 lines
3.9 KiB
Markdown
169 lines
3.9 KiB
Markdown
---
|
|
paths:
|
|
- "**/*.rs"
|
|
---
|
|
# Rust Patterns
|
|
|
|
> This file extends [common/patterns.md](../common/patterns.md) with Rust-specific content.
|
|
|
|
## Repository Pattern with Traits
|
|
|
|
Encapsulate data access behind a trait:
|
|
|
|
```rust
|
|
pub trait OrderRepository: Send + Sync {
|
|
fn find_by_id(&self, id: u64) -> Result<Option<Order>, StorageError>;
|
|
fn find_all(&self) -> Result<Vec<Order>, StorageError>;
|
|
fn save(&self, order: &Order) -> Result<Order, StorageError>;
|
|
fn delete(&self, id: u64) -> Result<(), StorageError>;
|
|
}
|
|
```
|
|
|
|
Concrete implementations handle storage details (Postgres, SQLite, in-memory for tests).
|
|
|
|
## Service Layer
|
|
|
|
Business logic in service structs; inject dependencies via constructor:
|
|
|
|
```rust
|
|
pub struct OrderService {
|
|
repo: Box<dyn OrderRepository>,
|
|
payment: Box<dyn PaymentGateway>,
|
|
}
|
|
|
|
impl OrderService {
|
|
pub fn new(repo: Box<dyn OrderRepository>, payment: Box<dyn PaymentGateway>) -> Self {
|
|
Self { repo, payment }
|
|
}
|
|
|
|
pub fn place_order(&self, request: CreateOrderRequest) -> anyhow::Result<OrderSummary> {
|
|
let order = Order::from(request);
|
|
self.payment.charge(order.total())?;
|
|
let saved = self.repo.save(&order)?;
|
|
Ok(OrderSummary::from(saved))
|
|
}
|
|
}
|
|
```
|
|
|
|
## Newtype Pattern for Type Safety
|
|
|
|
Prevent argument mix-ups with distinct wrapper types:
|
|
|
|
```rust
|
|
struct UserId(u64);
|
|
struct OrderId(u64);
|
|
|
|
fn get_order(user: UserId, order: OrderId) -> anyhow::Result<Order> {
|
|
// Can't accidentally swap user and order IDs at call sites
|
|
todo!()
|
|
}
|
|
```
|
|
|
|
## Enum State Machines
|
|
|
|
Model states as enums — make illegal states unrepresentable:
|
|
|
|
```rust
|
|
enum ConnectionState {
|
|
Disconnected,
|
|
Connecting { attempt: u32 },
|
|
Connected { session_id: String },
|
|
Failed { reason: String, retries: u32 },
|
|
}
|
|
|
|
fn handle(state: &ConnectionState) {
|
|
match state {
|
|
ConnectionState::Disconnected => connect(),
|
|
ConnectionState::Connecting { attempt } if *attempt > 3 => abort(),
|
|
ConnectionState::Connecting { .. } => wait(),
|
|
ConnectionState::Connected { session_id } => use_session(session_id),
|
|
ConnectionState::Failed { retries, .. } if *retries < 5 => retry(),
|
|
ConnectionState::Failed { reason, .. } => log_failure(reason),
|
|
}
|
|
}
|
|
```
|
|
|
|
Always match exhaustively — no wildcard `_` for business-critical enums.
|
|
|
|
## Builder Pattern
|
|
|
|
Use for structs with many optional parameters:
|
|
|
|
```rust
|
|
pub struct ServerConfig {
|
|
host: String,
|
|
port: u16,
|
|
max_connections: usize,
|
|
}
|
|
|
|
impl ServerConfig {
|
|
pub fn builder(host: impl Into<String>, port: u16) -> ServerConfigBuilder {
|
|
ServerConfigBuilder {
|
|
host: host.into(),
|
|
port,
|
|
max_connections: 100,
|
|
}
|
|
}
|
|
}
|
|
|
|
pub struct ServerConfigBuilder {
|
|
host: String,
|
|
port: u16,
|
|
max_connections: usize,
|
|
}
|
|
|
|
impl ServerConfigBuilder {
|
|
pub fn max_connections(mut self, n: usize) -> Self {
|
|
self.max_connections = n;
|
|
self
|
|
}
|
|
|
|
pub fn build(self) -> ServerConfig {
|
|
ServerConfig {
|
|
host: self.host,
|
|
port: self.port,
|
|
max_connections: self.max_connections,
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Sealed Traits for Extensibility Control
|
|
|
|
Use a private module to seal a trait, preventing external implementations:
|
|
|
|
```rust
|
|
mod private {
|
|
pub trait Sealed {}
|
|
}
|
|
|
|
pub trait Format: private::Sealed {
|
|
fn encode(&self, data: &[u8]) -> Vec<u8>;
|
|
}
|
|
|
|
pub struct Json;
|
|
impl private::Sealed for Json {}
|
|
impl Format for Json {
|
|
fn encode(&self, data: &[u8]) -> Vec<u8> { todo!() }
|
|
}
|
|
```
|
|
|
|
## API Response Envelope
|
|
|
|
Consistent API responses using a generic enum:
|
|
|
|
```rust
|
|
#[derive(Debug, serde::Serialize)]
|
|
#[serde(tag = "status")]
|
|
pub enum ApiResponse<T: serde::Serialize> {
|
|
#[serde(rename = "ok")]
|
|
Ok { data: T },
|
|
#[serde(rename = "error")]
|
|
Error { message: String },
|
|
}
|
|
```
|
|
|
|
## References
|
|
|
|
See skill: `rust-patterns` for comprehensive patterns including ownership, traits, generics, concurrency, and async.
|