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

NEVER use #[cfg(test)] modules inside implementation files.

Quality

• Functions <50 lines, commands 100-300 lines
• Zero warnings (except during TDD red phase)
• No comments by default (only for genuinely complex logic)
• Run just format before committing

Patterns

Iterating Instances

ctx.version_groups.iter().for_each(|group| {
    group.get_sorted_dependencies(&ctx.config.cli.sort).for_each(|dependency| {
        dependency.get_sorted_instances()
            .filter(|instance| instance.is_invalid())
            .for_each(|instance| { /* process */ });
    });
});

Error Handling

Prefer combinators over ?:

// Good
path.parent()
    .and_then(|p| p.to_str())
    .map(|s| s.to_string())
    .unwrap_or_default()

// Avoid
let parent = path.parent()?;
let str = parent.to_str()?;
Ok(str.to_string())

State Mutation

let mut state = instance.state.borrow_mut();
if !state.is_invalid() {
    *state = InstanceState::fixable(SomeVariant);
}