PLOW-38 - trckr

← PLOW-38

feature

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

Relationships Loading...

## Summary

Add a new function `render_workflow_mermaid()` to visualization.py that generates Mermaid flowchart syntax from the existing NetworkX graph.

## Implementation

### New Function

```python
def render_workflow_mermaid(config_dir: Path | None = None) -> str:
    """Render the workflow graph as Mermaid flowchart syntax."""
```

### Output Format

Generate valid Mermaid flowchart syntax:

```mermaid
graph TD
    check_status["1. Check Status (C)"]
    pick_issue["2. Pick Issue (A)"]
    ...
    
    check_status --> pick_issue
    pick_issue --> parse_issue_id
    ...
    
    check_qa_result -->|done| check_status
    check_qa_result -->|todo| check_status
```

### Requirements

1. Use `graph TD` (top-down) layout for linear workflow clarity
2. Node IDs: use step_key (e.g., `check_status`)
3. Node labels: formatted as `"1. Check Status (C)"` using existing `_format_node_label()`
4. Sequential edges: simple arrows `-->`
5. Conditional edges: labeled arrows `-->|status|` for status routing

## Files to Modify

- `src/trckr_plow/visualization.py` - Add `render_workflow_mermaid()` function
- `tests/test_visualization.py` - Add tests for Mermaid output

## Acceptance Criteria

- [ ] `render_workflow_mermaid()` returns valid Mermaid syntax string
- [ ] All 12 nodes are included with correct labels
- [ ] Sequential edges connect steps 1→2→3→...→12
- [ ] Status routing edges have labels (e.g., `|done|`, `|todo|`)
- [ ] Generated syntax renders without error in mermaid-cli
- [ ] Unit tests verify output format

Pull Requests (comma-separated URLs)

Attachments

Comments (1)

agent · 2025-12-21

Implemented render_workflow_mermaid() function in visualization.py. **What was done:** - Added render_workflow_mermaid() function (src/trckr_plow/visualization.py:183-260) - Uses graph TD (top-down) layout for linear workflow clarity - Node IDs use step_key (e.g., check_status) - Node labels formatted as "1. Check Status (C)" using _format_node_label() - Sequential edges use simple arrows --> - Conditional edges use labeled arrows -->|status| - Nodes sorted by step_number, edges sorted by source step number **Verification:** - Added 16 comprehensive tests (tests/test_visualization.py:538-703) - All 72 visualization tests pass - Generated syntax validated with mermaid-cli - renders to valid SVG without errors **Acceptance criteria met:** - [x] render_workflow_mermaid() returns valid Mermaid syntax string - [x] All 12 nodes included with correct labels - [x] Sequential edges connect steps 1→2→3→...→12 - [x] Status routing edges have labels (e.g., |done|, |todo|) - [x] Generated syntax renders without error in mermaid-cli - [x] Unit tests verify output format