Product Roadmap Visualizer (VS Code Extension)
Open roadmap YAML files as interactive dependency diagrams directly in VS Code.
Quick Start
- Open one of these files:
*.roadmap.yaml (recommended)
*.roadmap.yml (recommended)
roadmap.yaml
roadmap.yml
- Open the diagram with either:
- Editor title action:
Open Roadmap Diagram
- Explorer context menu:
Open Roadmap Diagram
- Command Palette:
Open Roadmap Diagram
What You Get
- Directed roadmap graph rendered with React Flow.
- Automatic ELK layout (left to right by default).
- Layout control: switch left-right <-> top-down from the canvas controls.
- Compact nodes with ID, tag dots, effort/prio.
- Side panel details on click.
- Optional
rationale section (between Description and Acceptance Criteria).
- Tag legend.
- Theme control:
Auto, Light, or Dark in the canvas controls.
- Theme-aware styling in
Auto mode (follows VS Code light/dark theme).
Reveal in YAML action from selected node.
File Discovery Order
If you run the command without passing a file directly, the extension looks for:
- Currently active file if it matches supported names.
<workspace>/roadmap/roadmap.roadmap.yaml (or .yml).
<workspace>/roadmap/roadmap.yaml (or .yml).
- First matching roadmap file in workspace (prioritizing
*.roadmap.yaml).
YAML Schema (State)
Each state supports:
id (required)
description (optional)
rationale (optional)
acceptanceCriteria (optional string array)
effort / prio (optional numbers)
tags (optional tag-id array)
depends_on (optional state-id array)
Commands
Open Roadmap Diagram (roadmapVisualizer.open)
Roadmap Visualizer: Refresh (roadmapVisualizer.refresh)
Package (.vsix)
Build a local installable extension package:
npm run package:vsix
Local Test Workflow (Before Publish)
Use this loop to test safely in your other VS Code instance:
- Build/package:
npm run package:vsix
- Install into the target VS Code instance:
code --install-extension roadmap-visualizer-vscode-<version>.vsix --force
If that instance is VS Code Insiders:
code-insiders --install-extension roadmap-visualizer-vscode-<version>.vsix --force
- Reload that window:
Cmd+Shift+P -> Developer: Reload Window
- Reopen a supported roadmap file and click
Open Roadmap Diagram.
Development
- Install dependencies:
npm install
- Build extension host + webview bundle:
npm run build
- In VS Code, press
F5 to launch an Extension Development Host.
Publish
- Make sure
publisher in package.json is your Marketplace publisher ID.
- Load your PAT environment (if you store it in
.zshrc):
source ~/.zshrc
- Login once (if not already logged in):
npx vsce login <your-publisher-id>
- Publish:
npm run publish:marketplace
Optional Web Mode
The previous Next.js web app is still available:
npm run dev:web
| |