PLOW-39 - trckr

← PLOW-39

feature

Created: 2025-12-21 • Updated: 2025-12-21

Relationships Loading...

## Summary

Extend `render_workflow_mermaid()` to support step highlighting via Mermaid's classDef styling, similar to the existing ASCII highlight feature.

## Implementation

### Function Signature

```python
def render_workflow_mermaid(
    config_dir: Path | None = None,
    step: str | None = None,
) -> str:
```

### Highlighting Approach

Use Mermaid's class-based styling:

```mermaid
graph TD
    classDef highlight fill:#ffeb3b,stroke:#ff9800,stroke-width:3px
    
    check_status["1. Check Status (C)"]:::highlight
    pick_issue["2. Pick Issue (A)"]
    ...
```

### Requirements

1. Add optional `step` parameter (same semantics as ASCII version)
2. Accept step by: key (`check_status`), name (`Check Status`), or number (`1`)
3. Define highlight class with distinct yellow/orange styling
4. Apply `:::highlight` suffix to the matching node
5. If step not found, generate diagram without highlighting (no error)

## Files to Modify

- `src/trckr_plow/visualization.py` - Extend `render_workflow_mermaid()`
- `tests/test_visualization.py` - Add tests for highlighting

## Acceptance Criteria

- [ ] `render_workflow_mermaid(step="check_status")` includes highlight class definition
- [ ] Highlighted node has `:::highlight` suffix
- [ ] Highlighting works by step key, name (case-insensitive), and number
- [ ] Unknown step generates diagram without highlighting
- [ ] Rendered SVG shows highlighted step in yellow/orange color
- [ ] Unit tests verify highlighting syntax

Pull Requests (comma-separated URLs)

Attachments

Comments (2)

agent · 2025-12-21

[QA] ✅ VERIFICATION PASSED All acceptance criteria met. Comprehensive testing completed: - 812/812 tests passing (including 16 new tests for this feature) - Manual verification of all highlighting scenarios successful - Code quality excellent, no regressions detected - Implementation matches requirements exactly Verified behaviors: ✓ Highlighting by step key, name (case-insensitive), and number ✓ Correct CSS class definition (yellow/orange colors) ✓ Graceful handling of unknown steps (no error, no highlight) ✓ Exactly one node highlighted when specified ✓ All edges and workflow structure preserved ✓ Backward compatible (optional parameter) Full QA report: /tmp/qa-PLOW-39.md

agent · 2025-12-21

## Implementation Summary Extended `render_workflow_mermaid()` to support step highlighting via Mermaid's classDef styling. ### Changes Made **src/trckr_plow/visualization.py:187-264** - Added optional `step` parameter to `render_workflow_mermaid()` - Implemented step matching by: key (`check_status`), name (case-insensitive, `Check Status`), or number (`1`) - Added `classDef highlight fill:#ffeb3b,stroke:#ff9800,stroke-width:3px` when highlighting - Applied `:::highlight` suffix to the matching node - If step not found, diagram generates without highlighting (no error) **tests/test_visualization.py:699-843** - Added 16 comprehensive tests covering: - Highlighting by key, number, and name (case-insensitive) - Unknown step handling (no highlighting, no error) - Correct classDef styling (yellow/orange colors) - Only highlighted node gets :::highlight suffix - Custom config directory support ### Verification - All 812 tests pass - Manual verification confirms correct Mermaid syntax output - Highlighting works for all match types (key, name, number) ### Example Output graph TD classDef highlight fill:#ffeb3b,stroke:#ff9800,stroke-width:3px check_status["1. Check Status (C)"]:::highlight pick_issue["2. Pick Issue (A)"] ...