update docs and rules to include vscode profile

This commit is contained in:
Joe Danziger
2025-06-04 22:38:19 -04:00
parent 0e49c06c4a
commit 880436b866
5 changed files with 16 additions and 16 deletions

View File

@@ -4,13 +4,13 @@
Added comprehensive rule profile management: Added comprehensive rule profile management:
- **New Profile Support**: Added comprehensive IDE profile support with seven specialized profiles: Claude Code, Cline, Codex, Cursor, Roo, Trae, and Windsurf. Each profile is optimized for its respective IDE with appropriate mappings and configuration. **New Profile Support**: Added comprehensive IDE profile support with eight specialized profiles: Claude Code, Cline, Codex, Cursor, Roo, Trae, VS Code, and Windsurf. Each profile is optimized for its respective IDE with appropriate mappings and configuration.
- **Initialization**: You can now specify which rule profiles to include at project initialization using `--rules <profiles>` or `-r <profiles>` (e.g., `task-master init -r cursor,roo`). Only the selected profiles and configuration are included. **Initialization**: You can now specify which rule profiles to include at project initialization using `--rules <profiles>` or `-r <profiles>` (e.g., `task-master init -r cursor,roo`). Only the selected profiles and configuration are included.
- **Add/Remove Commands**: `task-master rules add <profiles>` and `task-master rules remove <profiles>` let you manage specific rule profiles and MCP config after initialization, supporting multiple profiles at once. **Add/Remove Commands**: `task-master rules add <profiles>` and `task-master rules remove <profiles>` let you manage specific rule profiles and MCP config after initialization, supporting multiple profiles at once.
- **Interactive Setup**: `task-master rules setup` launches an interactive prompt to select which rule profiles to add to your project. This does **not** re-initialize your project or affect shell aliases; it only manages rules. **Interactive Setup**: `task-master rules setup` launches an interactive prompt to select which rule profiles to add to your project. This does **not** re-initialize your project or affect shell aliases; it only manages rules.
- **Selective Removal**: Rules removal intelligently preserves existing non-Task Master rules and files and only removes Task Master-specific rules. Profile directories are only removed when completely empty and all conditions are met (no existing rules, no other files/folders, MCP config completely removed). **Selective Removal**: Rules removal intelligently preserves existing non-Task Master rules and files and only removes Task Master-specific rules. Profile directories are only removed when completely empty and all conditions are met (no existing rules, no other files/folders, MCP config completely removed).
- **Safety Features**: Confirmation messages clearly explain that only Task Master-specific rules and MCP configurations will be removed, while preserving existing custom rules and other files. **Safety Features**: Confirmation messages clearly explain that only Task Master-specific rules and MCP configurations will be removed, while preserving existing custom rules and other files.
- **Robust Validation**: Includes comprehensive checks for array types in MCP config processing and error handling throughout the rules management system. **Robust Validation**: Includes comprehensive checks for array types in MCP config processing and error handling throughout the rules management system.
This enables more flexible, rule-specific project setups with intelligent cleanup that preserves user customizations while safely managing Task Master components. This enables more flexible, rule-specific project setups with intelligent cleanup that preserves user customizations while safely managing Task Master components.

View File

@@ -24,7 +24,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
* `--name <name>`: `Set the name for your project in Taskmaster's configuration.` * `--name <name>`: `Set the name for your project in Taskmaster's configuration.`
* `--description <text>`: `Provide a brief description for your project.` * `--description <text>`: `Provide a brief description for your project.`
* `--version <version>`: `Set the initial version for your project, e.g., '0.1.0'.` * `--version <version>`: `Set the initial version for your project, e.g., '0.1.0'.`
* `--rules <rules>` or `-r <rules>`: `Comma-separated list of rule sets to apply at initialization (e.g., 'cursor,windsurf,roo'). If not specified, all rule profiles are initialized by default.` * `--rules <rules>` or `-r <rules>`: `Comma-separated list of rule sets to apply at initialization (e.g., 'cursor,windsurf,roo,vscode'). If not specified, all rule profiles are initialized by default.`
* `-y, --yes`: `Initialize Taskmaster quickly using default settings without interactive prompts.` * `-y, --yes`: `Initialize Taskmaster quickly using default settings without interactive prompts.`
* **Usage:** Run this once at the beginning of a new project. * **Usage:** Run this once at the beginning of a new project.
* **Rules Examples:** * **Rules Examples:**
@@ -65,7 +65,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
* `add <rules>`: `Add one or more rule sets to your project (e.g., 'windsurf,roo').` * `add <rules>`: `Add one or more rule sets to your project (e.g., 'windsurf,roo').`
* `remove <rules>`: `Remove one or more rule sets from your project (e.g., 'windsurf').` * `remove <rules>`: `Remove one or more rule sets from your project (e.g., 'windsurf').`
* **Key Parameters:** * **Key Parameters:**
* `<rules>`: `Comma-separated list of rule sets to add or remove (e.g., 'cursor', 'windsurf', 'roo', 'cline', 'trae').` * `<rules>`: `Comma-separated list of rule sets to add or remove (e.g., 'cursor', 'windsurf', 'roo', 'cline', 'trae', 'vscode').`
* **Usage Examples:** * **Usage Examples:**
* `task-master rules add windsurf,roo`: `Add Windsurf and Roo rule sets to your project.` * `task-master rules add windsurf,roo`: `Add Windsurf and Roo rule sets to your project.`
* `task-master rules remove windsurf`: `Remove the Windsurf rule set from your project.` * `task-master rules remove windsurf`: `Remove the Windsurf rule set from your project.`

View File

@@ -162,7 +162,7 @@ task-master init
npx task-master init npx task-master init
# Initialize project with specific rules # Initialize project with specific rules
task-master init --rules cursor,windsurf task-master init --rules cursor,windsurf,vscode
``` ```
This will prompt you for project details and set up a new project with the necessary files and structure. This will prompt you for project details and set up a new project with the necessary files and structure.
@@ -186,7 +186,7 @@ task-master next
task-master generate task-master generate
# Add rules after initialization # Add rules after initialization
task-master rules add windsurf,roo task-master rules add windsurf,roo,vscode
``` ```
## Documentation ## Documentation

View File

@@ -24,7 +24,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
* `--name <name>`: `Set the name for your project in Taskmaster's configuration.` * `--name <name>`: `Set the name for your project in Taskmaster's configuration.`
* `--description <text>`: `Provide a brief description for your project.` * `--description <text>`: `Provide a brief description for your project.`
* `--version <version>`: `Set the initial version for your project, e.g., '0.1.0'.` * `--version <version>`: `Set the initial version for your project, e.g., '0.1.0'.`
* `--rules <rules>` or `-r <rules>`: `Comma-separated list of rule sets to apply at initialization (e.g., 'cursor,windsurf,roo'). If not specified, all rule profiles are initialized by default.` * `--rules <rules>` or `-r <rules>`: `Comma-separated list of rule sets to apply at initialization (e.g., 'cursor,windsurf,roo,vscode'). If not specified, all rule profiles are initialized by default.`
* `-y, --yes`: `Initialize Taskmaster quickly using default settings without interactive prompts.` * `-y, --yes`: `Initialize Taskmaster quickly using default settings without interactive prompts.`
* **Usage:** Run this once at the beginning of a new project. * **Usage:** Run this once at the beginning of a new project.
* **Rules Examples:** * **Rules Examples:**
@@ -65,7 +65,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
* `add <rules>`: `Add one or more rule sets to your project (e.g., 'windsurf,roo').` * `add <rules>`: `Add one or more rule sets to your project (e.g., 'windsurf,roo').`
* `remove <rules>`: `Remove one or more rule sets from your project (e.g., 'windsurf').` * `remove <rules>`: `Remove one or more rule sets from your project (e.g., 'windsurf').`
* **Key Parameters:** * **Key Parameters:**
* `<rules>`: `Comma-separated list of rule sets to add or remove (e.g., 'cursor', 'windsurf', 'roo', 'cline', 'trae').` * `<rules>`: `Comma-separated list of rule sets to add or remove (e.g., 'cursor', 'windsurf', 'roo', 'cline', 'trae', 'vscode').`
* **Usage Examples:** * **Usage Examples:**
* `task-master rules add windsurf,roo`: `Add Windsurf and Roo rule sets to your project.` * `task-master rules add windsurf,roo`: `Add Windsurf and Roo rule sets to your project.`
* `task-master rules remove windsurf`: `Remove the Windsurf rule set from your project.` * `task-master rules remove windsurf`: `Remove the Windsurf rule set from your project.`

View File

@@ -236,11 +236,11 @@ task-master add-task --prompt="Description" --priority=high
task-master init task-master init
# Initialize a new project applying specific rules # Initialize a new project applying specific rules
task-master init --rules cursor,windsurf task-master init --rules cursor,windsurf,vscode
``` ```
- The `--rules` flag allows you to specify one or more rule profiles (e.g., `cursor`, `roo`, `windsurf`, `cline`) to apply during initialization. - The `--rules` flag allows you to specify one or more rule profiles (e.g., `cursor`, `roo`, `windsurf`, `cline`) to apply during initialization.
- If omitted, all available rule profiles are installed by default (cursor, windsurf, roo, cline). - If omitted, all available rule profiles are installed by default (claude, cline, codex, cursor, roo, trae, vscode, windsurf).
- You can use multiple comma-separated profiles in a single command. - You can use multiple comma-separated profiles in a single command.
## Manage Rules ## Manage Rules
@@ -270,7 +270,7 @@ task-master rules setup
**Examples:** **Examples:**
```bash ```bash
task-master rules add windsurf,roo task-master rules add windsurf,roo,vscode
task-master rules remove windsurf task-master rules remove windsurf
task-master rules setup task-master rules setup
``` ```