write-code

name	write-code
description	Rust code style and conventions for Syncpack. Use when writing or modifying Rust code. Covers functional patterns, imports, naming, and quality standards.

Write Code

Rust code conventions for Syncpack.

Style

• Functional style: pipelines over loops
• Avoid ? chains: use .and_then(), .map(), .or_else()
• Descriptive names: clarity over brevity
• Named placeholders: println!("{var}") not println!("{}", var)
• British English: "behaviour" not "behavior", "organised" not "organized"

Imports

Single use statement with grouped braces:

use {
  crate::{cli::Cli, config::Config},
  log::{debug, error},
  std::{process::exit, sync::Arc},
};

Rules:

• Never use super:: — always crate:: for internal imports
• Group: crate::, external crates, std::
• Alphabetise within groups

File Organisation

Adding...	Location
New command	src/commands/{name}.rs
New test	Sibling _test.rs file (e.g., src/foo.rs → src/foo_test.rs)

use modules inside implementation files.