# VSCode Project Roadmap

A Visual Studio Code extension to visualize and track your project's progress by phase using a Markdown checklist file. Perfect for teams and solo developers who want a clear, interactive roadmap directly in their editor.

---

## Features

- **Roadmap Sidebar:** View your project phases and tasks as a collapsible tree in the VS Code sidebar.
- **Markdown Integration:** Uses a customizable Markdown checklist file (default: `Development Checklist.md`) for easy editing and version control.
- **Checkbox Sync:** Toggle tasks as complete/incomplete directly from the tree view—updates your Markdown file instantly.
- **Progress Indicators:** See completion bars and checkmarks for each phase at a glance.
- **Webview Overview:** Open a tab with a clean, read-only summary of your roadmap and progress.
- **Customizable Filename:** Change the checklist file via settings to fit any workflow.

---

## Screenshots

To come

---

## Requirements

- Visual Studio Code v1.101.0 or higher

---

## Extension Settings

This extension contributes the following settings:

| Setting                       | Description                                              | Default                    |
|-------------------------------|----------------------------------------------------------|----------------------------|
| `roadmapChecklist.filename`   | The relative path to the Markdown file used for roadmap. | `Development Checklist.md` |

You can change this in your workspace settings to use a different checklist file.

---

## Usage

1. **Prepare your checklist:**
   Use a Markdown file with phases as headings (`## Phase Name`) and tasks as checkboxes:

   ```markdown
   ## Phase 1: Planning
   - [ ] Define requirements
   - [x] Set up repository

   ## Phase 2: Development
   - [ ] Implement feature X
   - [ ] Write tests

   ```

2. **Open the Roadmap Sidebar:**
Click the "Roadmap" icon in the Activity Bar to view and interact with your checklist.
3. **Toggle tasks:**
Click checkboxes in the tree to mark tasks as complete/incomplete.
4. **View overview:**
Right-click a phase or use the command palette to open the roadmap overview tab.

---

## Known Issues

- Only supports checklists in Markdown files with - [ ] or - [x] syntax.
- Nested tasks are supported via indentation, but only one level deep is recommended for clarity.

---

## Release Notes

0.0.1
Initial release: Roadmap sidebar, checklist sync, overview tab, and settings.

---

## Contributing

Pull requests and suggestions are welcome! Please open an issue to discuss your ideas.

---

## Resources

- Extension Guidelines
- Markdown Syntax Reference

---

**Enjoy tracking your project roadmap in VS Code!**