{"id":28490947,"url":"https://github.com/fusepilot/prd-assistant-vscode","last_synced_at":"2025-07-07T18:31:30.873Z","repository":{"id":296350255,"uuid":"991618750","full_name":"fusepilot/prd-assistant-vscode","owner":"fusepilot","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-01T21:12:27.000Z","size":994,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-08T07:44:05.762Z","etag":null,"topics":["ai","prd","vscode"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=fusepilot.prd-assistant","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fusepilot.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-27T22:48:23.000Z","updated_at":"2025-06-01T21:12:31.000Z","dependencies_parsed_at":"2025-06-03T04:34:42.446Z","dependency_job_id":null,"html_url":"https://github.com/fusepilot/prd-assistant-vscode","commit_stats":null,"previous_names":["fusepilot/prd-assistant-vscode"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fusepilot/prd-assistant-vscode","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusepilot%2Fprd-assistant-vscode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusepilot%2Fprd-assistant-vscode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusepilot%2Fprd-assistant-vscode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusepilot%2Fprd-assistant-vscode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fusepilot","download_url":"https://codeload.github.com/fusepilot/prd-assistant-vscode/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fusepilot%2Fprd-assistant-vscode/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264130512,"owners_count":23562041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","prd","vscode"],"created_at":"2025-06-08T07:30:44.106Z","updated_at":"2025-07-07T18:31:30.868Z","avatar_url":"https://github.com/fusepilot.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PRD Assistant - VSCode Extension\n\nTransform your Product Requirements Documents into interactive, trackable project dashboards.\n\n## 📸 Screenshots\n\n### PRD Explorer Tree View\n![PRD Explorer](https://raw.githubusercontent.com/fusepilot/prd-assistant-vscode/master/images/prd-explorer.png)\n\nThe PRD Explorer provides a hierarchical view of all your tasks organized by headers, with completion percentages and progress indicators.\n\n### CodeLens Integration\n![CodeLens Actions](https://raw.githubusercontent.com/fusepilot/prd-assistant-vscode/master/images/prd-codelens.png)\n\nInline CodeLens actions let you interact with tasks directly in the editor - toggle completion, assign users, copy IDs, and view statistics.\n\n## 🎯 Features\n\n### ✅ Interactive Task Management\n\nTurn your markdown task lists into interactive checkboxes with automatic progress tracking.\n\n- Click checkboxes to toggle completion status\n- Automatic task ID generation (PRD-XXXXXX format)\n- Visual progress indicators\n- Nested task support with hierarchy tracking\n- Convert regular list items to tasks with one click\n\n### 👥 Smart Task Assignment\n\nAssign tasks to team members with @-mention syntax.\n\n- Syntax: `@username` for clear ownership\n- Visual highlighting of assignees\n- Bulk assignment capabilities\n- Track workload by team member\n\n### 🔗 Deep Linking System\n\nReference any task anywhere with automatic deep links.\n\n- Every task gets a unique ID (e.g., PRD-123456)\n- Click any PRD-XXXXXX reference to jump to that task\n- Copy shareable links with one click\n\n### 📊 Visual Progress Tracking\n\nGet instant visibility into project progress with multiple views.\n\n- Tree view explorer in sidebar with task hierarchy\n- Inline CodeLens statistics and actions\n- Progress reports with completion percentages\n- Real-time updates as you work\n- Export progress reports to CSV/JSON formats\n\n### 🎨 Enhanced Editing Experience\n\n- **CodeLens Actions**: Toggle tasks, assign users, copy IDs directly from the editor\n- **Quick Fixes**: Automatically resolve duplicate task IDs\n- **Format on Save**: Normalize checkbox formatting automatically\n- **Conversion Tools**: Convert list items to tasks in bulk or individually\n- **Tree View**: Organize tasks by headers with filtering options\n\n## 📋 Requirements\n\n- Visual Studio Code 1.100.0 or higher\n\n## 🚀 Getting Started\n\n### Installation from Marketplace\n\n1. Open VSCode\n2. Go to Extensions (Ctrl+Shift+X)\n3. Search for \"PRD Assistant\"\n4. Click Install\n\n### First Use\n\n1. **Create a PRD file**: Use the \"Create Empty PRD File\" button in the PRD Explorer or create any `.md` file with \"PRD\" in the name\n2. **Add tasks**: Write tasks using markdown syntax:\n\n   ```markdown\n   # My Project\n\n   ## Tasks\n\n   - [ ] Complete user authentication PRD-100001\n   - [ ] Design database schema @john PRD-100002\n   - [ ] Implement API endpoints PRD-100003\n   ```\n\n3. **Interactive features**: Click checkboxes, use CodeLens actions, and view progress in the PRD Explorer\n\n### Supported File Patterns\n\nBy default, PRD Assistant activates for files matching:\n\n- `*prd*.md`\n- `PRD*.md`\n- `*PRD*.md`\n\nYou can also configure additional files in settings.\n\n## 💻 Development Guide\n\n### Development Workflow\n\n1. **Launch Extension Development Host**\n\n   - Press `F5` in VSCode\n   - This opens a new \"Extension Development Host\" window\n   - Your extension is pre-installed in this window\n\n2. **Making Changes**\n\n   - Edit source files in `src/`\n   - Use `npm run watch` for auto-compilation\n   - Reload with \"Developer: Reload Window\" (Ctrl+Shift+P)\n\n3. **Testing**\n   - Create test PRD.md files\n   - Test checkboxes, assignments, deep links\n   - Check the PRD Explorer view\n\n### Available Scripts\n\n```bash\n# Development\nnpm run compile     # Build TypeScript\nnpm run watch       # Watch mode for development\nnpm run lint        # Run ESLint\nnpm run test        # Run tests\n\n# Packaging \u0026 Publishing\nnpm run package     # Create .vsix file for testing\nnpm run package:pre # Create pre-release .vsix\nnpm run build:prod  # Clean, compile, and package\n\n# Publishing (requires vsce login)\nnpm run publish       # Publish current version\nnpm run publish:patch # Bump patch version and publish\nnpm run publish:minor # Bump minor version and publish\nnpm run publish:major # Bump major version and publish\n\n# Utilities\nnpm run clean       # Remove build artifacts\n```\n\n### Project Structure\n\n```\nprd-assistant/\n├── src/\n│   ├── extension.ts                           # Main extension entry point\n│   ├── managers/\n│   │   └── prdTaskManager.ts                  # Core task management logic\n│   ├── models/\n│   │   ├── task.ts                            # Task data models\n│   │   └── treeNode.ts                        # Tree view models\n│   ├── providers/\n│   │   ├── prdTreeProvider.ts                 # Sidebar tree view\n│   │   ├── prdCodeLensProvider.ts             # Inline actions\n│   │   ├── prdDecorationProvider.ts           # Text decorations\n│   │   ├── prdDocumentLinkProvider.ts         # Deep linking\n│   │   ├── prdQuickFixProvider.ts             # Auto-fixes\n│   │   └── prdConversionCodeLensProvider.ts   # List conversion\n│   ├── utils/\n│   │   └── prdUtils.ts                        # Utility functions\n│   └── test/\n│       └── extension.test.ts                  # Test suite\n├── syntaxes/\n│   └── prd.tmLanguage.json                    # Syntax highlighting\n├── images/                                    # Extension icons\n├── package.json                               # Extension manifest\n└── README.md                                  # This file\n```\n\n## ⚙️ Extension Settings\n\nConfigure PRD Assistant through VSCode settings:\n\n### Core Settings\n\n- `prdAssistant.autoGenerateIds`: Automatically generate task IDs (default: `true`)\n- `prdAssistant.taskIdPrefix`: Prefix for generated task IDs (default: `\"PRD\"`)\n- `prdAssistant.idFormat`: ID generation strategy - `\"sequential\"` or `\"timestamp\"` (default: `\"sequential\"`)\n\n### Display Settings\n\n- `prdAssistant.showCodeLens`: Show inline task actions (default: `true`)\n- `prdAssistant.enableCodeLensForHeaders`: Show stats and 'Add Task' on headers (default: `true`)\n- `prdAssistant.enableCodeLensForTasks`: Show action buttons on tasks (default: `true`)\n- `prdAssistant.enableConversionCodeLens`: Show 'Convert to Task' on list items (default: `true`)\n- `prdAssistant.showProgressInTreeView`: Display completion percentages (default: `true`)\n\n### File Detection\n\n- `prdAssistant.filePatterns`: File patterns to identify PRD files (default: `[\"*prd*.md\", \"PRD*.md\", \"*PRD*.md\"]`)\n- `prdAssistant.additionalFiles`: Specific files to enhance with PRD features (default: `[]`)\n  - Example: `[\"CLAUDE.md\", \"TODO.md\", \"TASKS.md\"]`\n- `prdAssistant.searchSubdirectoriesDepth`: Maximum directory depth to search (default: `1`)\n  - `0`: Only workspace root\n  - `1`: Root + immediate child folders (default)\n  - `2`: Root + 2 levels deep\n  - `99`: Search all subdirectories\n  - **Performance**: Lower values improve performance in large projects\n\n### Behavior Settings\n\n- `prdAssistant.normalizeCheckboxes`: Auto-fix checkbox formatting on save (default: `true`)\n- `prdAssistant.autoProcessDocuments`: Auto-process PRD files when opened (default: `true`)\n- `prdAssistant.showDuplicateWarnings`: Show warnings for duplicate task IDs (default: `true`)\n- `prdAssistant.enableQuickFixes`: Enable auto-fixes for duplicates (default: `true`)\n\n### Visual Enhancement\n\n- `prdAssistant.decorateAssignees`: Highlight @-mentions (default: `true`)\n- `prdAssistant.decorateDeepLinks`: Make task IDs clickable (default: `true`)\n- `prdAssistant.enableDecorations`: Enable visual decorations (default: `true`)\n\n## 🔧 Key Features Explained\n\n### Task ID Generation\n\n- **Sequential**: PRD-100001, PRD-100002, etc. (recommended)\n- **Timestamp**: Based on current timestamp for uniqueness\n- **Smart Collision Avoidance**: Automatically detects existing IDs\n\n### CodeLens Actions\n\n- **On Headers**: View completion stats, add tasks\n- **On Tasks**: Toggle completion, assign users, copy IDs\n- **On List Items**: Convert to tasks with auto-generated IDs\n\n### Tree View Features\n\n- **Hierarchical Display**: Tasks organized by headers\n- **Progress Indicators**: Completion percentages\n- **Filtering**: Show all, completed, or uncompleted tasks\n- **Multi-file Support**: Handle multiple PRD files in workspace\n\n### Checkbox Normalization\n\nAutomatically fixes common checkbox formatting issues:\n\n- `[]` → `[ ]` (adds space for empty checkbox)\n- `[x ]`, `[ x]`, `[ x ]` → `[x]` (normalizes checked checkbox)\n\n## 🐛 Known Issues\n\n- Task IDs might regenerate if file is edited outside VSCode\n- Large files (\u003e1000 tasks) may have performance impact\n- Deep links only work within the same workspace\n\n## ⚡ Performance Tips\n\n- **Large Projects**: Use `prdAssistant.searchSubdirectoriesDepth: 0` to search only workspace root for maximum performance\n- **Medium Projects**: Default depth of `1` provides good balance between performance and coverage\n- **File Organization**: Place PRD files in the workspace root or immediate child folders for optimal performance\n- **Deep Structures**: Use `additionalFiles` to explicitly list PRD files in deep subdirectories instead of increasing search depth\n\n## 📝 Release Notes\n\n### 1.0.0 - Initial Release\n\n- ✅ Interactive checkbox functionality\n- 🆔 Automatic task ID generation with collision avoidance\n- 👥 Task assignment with @-mentions\n- 🔗 Deep linking between tasks\n- 📊 Progress tracking and reporting\n- 🎨 Syntax highlighting for PRD files\n- 🌳 Tree view explorer with hierarchy\n- 📋 CodeLens integration for inline actions\n- 🔄 List item to task conversion\n- 📤 CSV/JSON export functionality\n- 🔧 Quick fixes for duplicate IDs\n- ⚡ Auto-format checkbox normalization\n\n## 🤝 Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙋‍♀️ Support\n\n- **Issues**: [GitHub Issues](https://github.com/fusepilot/prd-assistant-vscode/issues)\n- **Documentation**: Check this README and the extension's built-in help\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffusepilot%2Fprd-assistant-vscode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffusepilot%2Fprd-assistant-vscode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffusepilot%2Fprd-assistant-vscode/lists"}