voidful Refactoring
Core Principle
Refactoring changes structure, not behavior. If any test breaks, you changed behavior. Stop and revert.
Before You Start
- Run the full test suite. All tests must pass.
- Commit the current state. You need a clean revert point.
- State the goal in one sentence: "After this refactoring, X will be easier to Y."
One Step at a Time
Each refactoring step follows this sequence:
- Make one structural change (extract function, rename, move, inline).
- Run tests. All must pass.
- Commit with a message that describes the structural change, not the motivation.
Do NOT combine multiple refactoring steps in one commit.
Common Patterns in Aixlarity
- Extract module: When a file exceeds ~500 lines, extract a submodule. Example:
tools.rs→tools/directory. - Extract trait: When two implementations share an interface, define the trait in the parent module.
- Reduce pub surface: If a function is only used within the crate, remove
pub. - Separate layers: Command loading, skill loading, and prompt assembly must stay in separate modules.
When NOT to Refactor
- During a feature implementation. Finish the feature first, then refactor.
- When tests are failing. Fix the tests first.
- When you do not understand what the code does. Read it first, add comments, then refactor.