In-Editor Automated Refactoring Interface Brief

Role: Staff Developer Tooling UI/UX Designer specializing in code intelligence and in-editor keyboard ergonomics.

Context

• Host IDE platform: {{ide_environment}}
• Code transformation scope: {{ast_modification_types}}
• Keybinding bindings: {{keyboard_shortcut_scheme}}
• Validation gates: {{safety_verification_states}}
• Concurrency & merge logic: {{conflict_resolution_model}}
• Velocity targets: {{developer_experience_metrics}}

Task

Author a comprehensive interface brief for an in-editor refactoring engine UI that provides clear diff previews, guarantees non-destructive edits, and reduces cognitive load during multi-file automated code rewrites.

Method

1. Establish the HUD container paradigm (inline lens, peek view, side panel, or modal) optimized for {{ide_environment}}.
2. Detail the unified vs. split diff viewer components, outlining how syntax highlighting and AST change tokens are differentiated.
3. Map the state progression from code analysis to dry-run verification using {{safety_verification_states}}.
4. Define the micro-interactions and keystroke flows based on {{keyboard_shortcut_scheme}} to allow full headless operation.
5. Specify UI feedback for dirty workspaces and collision handling according to {{conflict_resolution_model}}.
6. Architect the multi-file review list with granular stage/unstage/reject controls per hunk.
7. Detail telemetry-safe feedback loops to track {{developer_experience_metrics}} without leaking source code.

Constraints

• MUST preserve the developer's cursor position and viewport scroll anchor upon applying or canceling changes.
• MUST NOT block the main IDE thread or render unfocused modal overlays that steal system focus.
• Contrast ratios for semantic code token changes must pass WCAG AA standards in both light and dark themes.
• Provide an instantaneous undo/revert micro-interaction for applied batch edits.

Output format

Structure the specification brief into these clear sections:

1. Architectural HUD Specification (Placement, overlay mechanics, and host IDE integration)
2. Interactive Diff & Token Preview Component (Visual state taxonomy, hunk actions, and AST markers)
3. Safety Gate & Pre-Flight Validation UI (Error chips, blocking states, and dry-run indicators)
4. Keystroke Navigation Table (Mapped keybindings, modifier states, and accessibility hooks)
5. Error & Conflict Recovery Flows (Edge-case UI handling for file locks and external modifications)

Self-review

• Check that all {{ast_modification_types}} have clear representation in the multi-file preview schema.
• Verify keyboard navigation can execute the full accept/reject lifecycle without mouse input.
• Ensure conflict recovery states prevent accidental data loss in dirty Git repositories.