// Add new features to Syncpack including commands and validation logic. Use when implementing new CLI commands, adding InstanceState variants, or extending version group behaviour.
| name | add-feature |
| description | Add new features to Syncpack including commands and validation logic. Use when implementing new CLI commands, adding InstanceState variants, or extending version group behaviour. |
Guide for adding new functionality to Syncpack.
What are you adding?
Before adding any feature:
ast-grep -p 'PATTERN' src/)Commands are user-facing operations (syncpack lint, syncpack fix, etc.).
When to create a new command:
Registration points (all three required):
src/cli.rs - Add to Subcommand enumsrc/main.rs - Add match arm for dispatchsrc/commands/*.rs - Implement pub fn run(ctx: Context) -> i32→ Full guide: adding-command.md
InstanceState variants describe validation results (valid, fixable, unfixable, suspect).
When to add a new state:
Location: src/instance_state.rs + src/visit_packages/*.rs
→ Full guide: adding-instance-state.md
cargo clippy and fix warningsBefore submitting:
just test)Rust code style and conventions for Syncpack. Use when writing or modifying Rust code. Covers functional patterns, imports, naming, and quality standards.
Write tests for Syncpack using the TestBuilder pattern. Use when adding tests for commands, validation logic, or any new functionality. Covers TestBuilder API, assertion patterns, and common test scenarios.
Run coverage, inspect results, and identify missing test scenarios for a given source file. Use when analysing test coverage or finding untested branches.
Add and update the documentation website for Syncpack. Use when making user-facing changes to the codebase.
Debug and fix bugs in Syncpack using scientific debugging methodology. Use when a test is failing, unexpected behaviour occurs, or investigating issues. Covers hypothesis-driven debugging and TDD-based fixes.
Put the answer first, then context and details follow. Use when writing documentation, tutorials, error messages, or any communication where readers need to decide quickly if something is relevant to them.