Add Feature
Developmentadd-featureAdd Feature is an Agent Skill for development published in the JamieMason/syncpack repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Add new features to Syncpack including commands and validation logic. Use when implementing new CLI commands, adding InstanceState variants, or extending version group behaviour.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/JamieMason/syncpack/blob/HEAD/.claude/skills/add-feature/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/add-feature, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Add Feature
Guide for adding new functionality to Syncpack.
Quick Decision
What are you adding?
- New CLI command (lint, fix, format, etc.) → See adding-command.md
- New validation logic (InstanceState variant) → See adding-instance-state.md
- Both → Start with instance state, then add command
Prerequisites
Before adding any feature:
- Understand the 3-phase pattern: Create Context → Inspect Context → Run Command
- Know which phase your feature affects
- Check if similar code exists (use
ast-grep -p 'PATTERN' src/)
Feature Types
Commands
Commands are user-facing operations (syncpack lint, syncpack fix, etc.).
When to create a new command:
- New user-facing operation that doesn't fit existing commands
- Different output format or behaviour needed
Registration points (all three required):
src/cli.rs- Add toSubcommandenumsrc/main.rs- Add match arm for dispatchsrc/commands/*.rs- Implementpub fn run(ctx: Context) -> i32
→ Full guide: adding-command.md
Instance States
InstanceState variants describe validation results (valid, fixable, unfixable, suspect).
When to add a new state:
- New validation rule needed
- New type of error/warning to report
- New auto-fix capability
Location: src/instance_state.rs + src/visit_packages/*.rs
→ Full guide: adding-instance-state.md
Common Workflow
- Write failing test using TestBuilder
- Implement minimal code to pass
- Run
cargo clippyand fix warnings - Refactor if needed
- Update documentation
Checklist
Before submitting:
- Tests pass (
just test) - Zero clippy warnings
- Follows existing patterns
- Registered in all required places (for commands)
- Uses TDD approach