95c299df64
* move claude rules and commands to assets/claude * update claude profile to copy assets/claude to .claude * fix formatting * feat(profiles): Implement unified profile system - Convert Claude and Codex profiles to use createProfile() factory - Remove simple vs complex profile distinction in rule transformer - Unify convertAllRulesToProfileRules() to handle all profiles consistently - Fix mcpConfigPath construction in base-profile.js for null mcpConfigName - Update terminology from 'simpleProfiles' to 'assetOnlyProfiles' throughout - Ensure Claude .claude directory copying works in both CLI and MCP contexts - All profiles now follow same execution flow with proper lifecycle functions Changes: - src/profiles/claude.js: Convert to createProfile() factory pattern - src/profiles/codex.js: Convert to createProfile() factory pattern - src/utils/rule-transformer.js: Unified profile handling logic - src/utils/profiles.js: Remove simple profile categorization - src/profiles/base-profile.js: Fix mcpConfigPath construction - scripts/modules/commands.js: Update variable naming - tests/: Update all tests for unified system and terminology Fixes Claude profile asset copying issue in MCP context. All tests passing (617 passed, 11 skipped). * re-checkin claude files * fix formatting * chore: clean up test Claude rules files * chore: add changeset for unified profile system * add claude files back * add changeset * restore proper gitignore * remove claude agents file from root * remove incorrect doc * simplify profiles and update tests * update changeset * update changeset * remove profile specific code * streamline profiles with defaults and update tests * update changeset * add newline at end of gitignore * restore changes * streamline profiles with defaults; update tests and add vscode test * update rule profile tests * update wording for clearer profile management * refactor and clarify terminology * use original projectRoot var name * revert param desc * use updated claude assets from neno * add "YOUR_" before api key here * streamline codex profile * add gemini profile * update gemini profile * update tests * relocate function * update rules interactive setup Gemini desc * remove duplicative code * add comma
117 lines
2.1 KiB
Markdown
117 lines
2.1 KiB
Markdown
Export tasks to README.md with professional formatting.
|
|
|
|
Arguments: $ARGUMENTS
|
|
|
|
Generate a well-formatted README with current task information.
|
|
|
|
## README Synchronization
|
|
|
|
Creates or updates README.md with beautifully formatted task information.
|
|
|
|
## Argument Parsing
|
|
|
|
Optional filters:
|
|
- "pending" → Only pending tasks
|
|
- "with-subtasks" → Include subtask details
|
|
- "by-priority" → Group by priority
|
|
- "sprint" → Current sprint only
|
|
|
|
## Execution
|
|
|
|
```bash
|
|
task-master sync-readme [--with-subtasks] [--status=<status>]
|
|
```
|
|
|
|
## README Generation
|
|
|
|
### 1. **Project Header**
|
|
```markdown
|
|
# Project Name
|
|
|
|
## 📋 Task Progress
|
|
|
|
Last Updated: 2024-01-15 10:30 AM
|
|
|
|
### Summary
|
|
- Total Tasks: 45
|
|
- Completed: 15 (33%)
|
|
- In Progress: 5 (11%)
|
|
- Pending: 25 (56%)
|
|
```
|
|
|
|
### 2. **Task Sections**
|
|
Organized by status or priority:
|
|
- Progress indicators
|
|
- Task descriptions
|
|
- Dependencies noted
|
|
- Time estimates
|
|
|
|
### 3. **Visual Elements**
|
|
- Progress bars
|
|
- Status badges
|
|
- Priority indicators
|
|
- Completion checkmarks
|
|
|
|
## Smart Features
|
|
|
|
1. **Intelligent Grouping**
|
|
- By feature area
|
|
- By sprint/milestone
|
|
- By assigned developer
|
|
- By priority
|
|
|
|
2. **Progress Tracking**
|
|
- Overall completion
|
|
- Sprint velocity
|
|
- Burndown indication
|
|
- Time tracking
|
|
|
|
3. **Formatting Options**
|
|
- GitHub-flavored markdown
|
|
- Task checkboxes
|
|
- Collapsible sections
|
|
- Table format available
|
|
|
|
## Example Output
|
|
|
|
```markdown
|
|
## 🚀 Current Sprint
|
|
|
|
### In Progress
|
|
- [ ] 🔄 #5 **Implement user authentication** (60% complete)
|
|
- Dependencies: API design (#3 ✅)
|
|
- Subtasks: 4 (2 completed)
|
|
- Est: 8h / Spent: 5h
|
|
|
|
### Pending (High Priority)
|
|
- [ ] ⚡ #8 **Create dashboard UI**
|
|
- Blocked by: #5
|
|
- Complexity: High
|
|
- Est: 12h
|
|
```
|
|
|
|
## Customization
|
|
|
|
Based on arguments:
|
|
- Include/exclude sections
|
|
- Detail level control
|
|
- Custom grouping
|
|
- Filter by criteria
|
|
|
|
## Post-Sync
|
|
|
|
After generation:
|
|
1. Show diff preview
|
|
2. Backup existing README
|
|
3. Write new content
|
|
4. Commit reminder
|
|
5. Update timestamp
|
|
|
|
## Integration
|
|
|
|
Works well with:
|
|
- Git workflows
|
|
- CI/CD pipelines
|
|
- Project documentation
|
|
- Team updates
|
|
- Client reports |