prompt-suite 1.0.3 → 1.0.5

package/README.md

@@ -2,6 +2,37 @@
 
 **Prompt Suite** is a comprehensive prompt system that automates the software development process from raw customer request → production-ready code + tests.
 
+## 📑 Table of Contents
+
+- [Installation](#-installation)
+- [Updating / Upgrading](#-updating--upgrading)
+- [Overview](#-overview)
+- [Complete Workflow](#-complete-workflow-6-steps)
+- [Quick Start](#-quick-start)
+- [What Gets Installed](#-what-gets-installed)
+- [Available Commands](#-available-commands)
+  - [Step 0: Coding Rules](#step-0-coding-rules-one-time-setup)
+  - [Step 1: Requirements](#step-1-requirements)
+  - [Step 2: Technical Design](#step-2-technical-design)
+  - [Step 3: Feature Code](#step-3-feature-code-)
+  - [Step 4: Test Plan](#step-4-test-plan)
+  - [Step 5: Test Code](#step-5-test-code-)
+  - [Step 6: Analysis](#step-6-analysis)
+- [Usage Tips](#-usage-tips)
+  - [Input Format](#input-format)
+  - [Task ID Requirement](#task-id-requirement)
+  - [Task ID Types](#task-id-types)
+  - [Applying Patches](#applying-patches)
+  - [Flexible Workflow](#flexible-workflow)
+- [Multi-Language Support](#-multi-language-support)
+- [File Structure](#-file-structure)
+- [Manual IDE Setup](#-manual-ide-setup)
+- [Complete Example](#-complete-example)
+- [Contributing](#-contributing)
+- [License](#-license)
+
+---
+
 ## 📦 Installation
 
 To install Prompt Suite in your project:
@@ -32,9 +63,17 @@ The installer will:
 
 ## 🔄 Updating / Upgrading
 
-When you upgrade `prompt-suite` to a newer version:
+To update `prompt-suite` to the latest version:
+
+### 1. Update the package
+
+```bash
+npm install prompt-suite@latest -D
+```
+
+### 2. Update resources and prompts
 
-### Safe Mode (Default):
+#### Safe Mode (Default):
 
 Preserves your customizations by skipping modified files:
 
@@ -42,7 +81,7 @@ Preserves your customizations by skipping modified files:
 npx prompt-suite init
 ```
 
-### Force Overwrite:
+#### Force Overwrite:
 
 Resets everything to latest defaults (⚠️ overwrites your changes):
 
@@ -50,7 +89,7 @@ Resets everything to latest defaults (⚠️ overwrites your changes):
 npx prompt-suite init --force
 ```
 
-### Conflict Resolution:
+#### Conflict Resolution:
 
 If a file exists but differs from the new version, a `.new` file will be created (e.g., `README.md.new`) for manual comparison and merging.
 
@@ -95,7 +134,7 @@ Select your IDE when prompted. Prompts will be automatically installed.
 
 ```bash
 # Copy template
-cp prompt-suite/templates/gen-rule-template.txt my-rules.txt
+cp prompt-suite/tasks/templates/gen-rule-template.md my-rules.txt
 
 # Edit my-rules.txt with your stack info
 # Then generate rules:
@@ -106,20 +145,20 @@ cp prompt-suite/templates/gen-rule-template.txt my-rules.txt
 
 ```bash
 # Copy template
-cp prompt-suite/templates/gen-requirement-template.txt FEAT-001-request.txt
+cp prompt-suite/tasks/templates/gen-requirement-template.md FEAT-001-request.txt
 
 # Edit FEAT-001-request.txt with your feature request
 # Then generate requirement:
 /ps.1-gen-requirement FEAT-001-request.txt
 
 # Generate design:
-/ps.2-gen-design prompt-suite/specs/FEAT-001/FEAT-001-requirement.md
+/ps.2-gen-design prompt-suite/tasks/FEAT-001/FEAT-001-requirement.md
 
 # Generate code:
-/ps.3-gen-code prompt-suite/specs/FEAT-001/FEAT-001-design.md
+/ps.3-gen-code prompt-suite/tasks/FEAT-001/FEAT-001-design.md
 
 # Apply the patch:
-git apply prompt-suite/specs/FEAT-001/FEAT-001-feature.patch
+git apply prompt-suite/tasks/FEAT-001/FEAT-001-feature.patch
 ```
 
 ---
@@ -130,8 +169,9 @@ git apply prompt-suite/specs/FEAT-001/FEAT-001-feature.patch
 
 - `rules/` - Generated coding rules (from Step 0)
 - `scripts/` - Setup scripts for manual IDE configuration
-- `templates/` - Input templates for commands
-- `specs/` - Generated specifications and patches
+- `tasks/` - Task artifacts and templates
+  - `templates/` - Input templates for commands
+  - `{TASK-ID}/` - Generated task artifacts (requirements, designs, patches)
 - `README.md` - This documentation
 
 ### In your IDE:
@@ -223,27 +263,51 @@ All commands require **file path input** (not direct text):
 
 ### Task ID Requirement
 
-Filenames **must contain a Task ID** (e.g., `FEAT-001`, `TASK-123`):
+Filenames **must contain a Task ID** (e.g., `FEAT-001`, `BUG-123`):
 
 ```bash
 # ✅ Valid filenames
 /ps.1-gen-requirement customer-request-FEAT-001.txt
-/ps.2-gen-design TASK-123-spec.md
+/ps.2-gen-design BUG-123-bugfix.md
 
 # ❌ Invalid - no Task ID
 /ps.1-gen-requirement request.txt
 ```
 
+### Task ID Types
+
+Task IDs follow the pattern: `{TYPE}-{NUMBER}`
+
+| Type             | Purpose                      | Example        |
+| ---------------- | ---------------------------- | -------------- |
+| **FEAT-xxx**     | New feature or functionality | `FEAT-001`     |
+| **BUG-xxx**      | Bug fix                      | `BUG-042`      |
+| **IMP-xxx**      | Improvement or enhancement   | `IMP-023`      |
+| **REFACTOR-xxx** | Code refactoring             | `REFACTOR-001` |
+| **HOTFIX-xxx**   | Critical production fix      | `HOTFIX-001`   |
+| **SPIKE-xxx**    | Research or investigation    | `SPIKE-001`    |
+| **CHORE-xxx**    | Maintenance tasks            | `CHORE-015`    |
+
+**Examples:**
+
+- `FEAT-001`: User login with email/password
+- `BUG-042`: Fix payment calculation error
+- `IMP-023`: Improve API response time
+- `HOTFIX-001`: Fix SQL injection vulnerability
+- `CHORE-015`: Update npm dependencies
+
+> 💡 See `prompt-suite/tasks/templates/TASK-ID-TYPES.md` for detailed guidelines
+
 ### Applying Patches
 
 Steps 3 and 5 generate patch files that you must manually apply:
 
 ```bash
 # Check if patch can be applied
-git apply --check prompt-suite/specs/FEAT-001/FEAT-001-feature.patch
+git apply --check prompt-suite/tasks/FEAT-001/FEAT-001-feature.patch
 
 # Apply the patch
-git apply prompt-suite/specs/FEAT-001/FEAT-001-feature.patch
+git apply prompt-suite/tasks/FEAT-001/FEAT-001-feature.patch
 
 # Review and commit
 git status
@@ -306,15 +370,15 @@ project/
 │   ├── scripts/                     # Manual setup scripts
 │   │   ├── setup-ps-chat-vscode.sh
 │   │   └── setup-ps-chat-antigravity.sh
-│   ├── templates/                   # Input templates
-│   │   ├── gen-rule-template.txt
-│   │   └── gen-requirement-template.txt
-│   ├── specs/                       # Generated specs & patches
-│   │   └── FEAT-001/
+│   ├── tasks/                       # Task artifacts & templates
+│   │   ├── templates/               # Input templates
+│   │   │   ├── gen-rule-template.md
+│   │   │   └── gen-requirement-template.md
+│   │   └── FEAT-001/                # Generated task artifacts
 │   │       ├── FEAT-001-requirement.md
 │   │       ├── FEAT-001-design.md
 │   │       ├── FEAT-001-test.md
-│   │       ├── FEAT-001-feature.patch
+│   │       ├── FEAT-001-code.patch
 │   │       └── FEAT-001-test.patch
 │   └── README.md
 │
@@ -354,7 +418,7 @@ bash prompt-suite/scripts/setup-ps-chat-antigravity.sh
 #### Step 0: Generate Rules (One-time)
 
 ```bash
-cp prompt-suite/templates/gen-rule-template.txt my-rules.txt
+cp prompt-suite/tasks/templates/gen-rule-template.md my-rules.txt
 # Edit: Step: all, Stack: Laravel + Vue.js, Architecture: Clean Architecture
 /ps.0-gen-rules my-rules.txt
 ```
@@ -362,27 +426,27 @@ cp prompt-suite/templates/gen-rule-template.txt my-rules.txt
 #### Step 1: Generate Requirement
 
 ```bash
-cp prompt-suite/templates/gen-requirement-template.txt FEAT-001-request.txt
+cp prompt-suite/tasks/templates/gen-requirement-template.md FEAT-001-request.txt
 # Edit: Task ID: FEAT-001, Raw Request: User login with email/password...
 /ps.1-gen-requirement FEAT-001-request.txt
-/ps.1-rev-requirement prompt-suite/specs/FEAT-001/FEAT-001-requirement.md
+/ps.1-rev-requirement prompt-suite/tasks/FEAT-001/FEAT-001-requirement.md
 ```
 
 #### Step 2: Generate Design
 
 ```bash
-/ps.2-gen-design prompt-suite/specs/FEAT-001/FEAT-001-requirement.md
-/ps.2-rev-design prompt-suite/specs/FEAT-001/FEAT-001-design.md
+/ps.2-gen-design prompt-suite/tasks/FEAT-001/FEAT-001-requirement.md
+/ps.2-rev-design prompt-suite/tasks/FEAT-001/FEAT-001-design.md
 ```
 
 #### Step 3: Generate Code
 
 ```bash
-/ps.3-gen-code prompt-suite/specs/FEAT-001/FEAT-001-design.md
+/ps.3-gen-code prompt-suite/tasks/FEAT-001/FEAT-001-design.md
 
 # Apply patch
-git apply --check prompt-suite/specs/FEAT-001/FEAT-001-feature.patch
-git apply prompt-suite/specs/FEAT-001/FEAT-001-feature.patch
+git apply --check prompt-suite/tasks/FEAT-001/FEAT-001-feature.patch
+git apply prompt-suite/tasks/FEAT-001/FEAT-001-feature.patch
 git add .
 git commit -m "feat: user login with rate limiting (FEAT-001)"
 ```
@@ -390,18 +454,18 @@ git commit -m "feat: user login with rate limiting (FEAT-001)"
 #### Step 4: Generate Test Plan
 
 ```bash
-/ps.4-gen-test-plan prompt-suite/specs/FEAT-001/FEAT-001-design.md
-/ps.4-rev-test-plan prompt-suite/specs/FEAT-001/FEAT-001-design.md prompt-suite/specs/FEAT-001/FEAT-001-test.md
+/ps.4-gen-test-plan prompt-suite/tasks/FEAT-001/FEAT-001-design.md
+/ps.4-rev-test-plan prompt-suite/tasks/FEAT-001/FEAT-001-design.md prompt-suite/tasks/FEAT-001/FEAT-001-test.md
 ```
 
 #### Step 5: Generate Test Code
 
 ```bash
-/ps.5-gen-test-code prompt-suite/specs/FEAT-001/FEAT-001-test.md
+/ps.5-gen-test-code prompt-suite/tasks/FEAT-001/FEAT-001-test.md
 
 # Apply test patch
-git apply --check prompt-suite/specs/FEAT-001/FEAT-001-test.patch
-git apply prompt-suite/specs/FEAT-001/FEAT-001-test.patch
+git apply --check prompt-suite/tasks/FEAT-001/FEAT-001-test.patch
+git apply prompt-suite/tasks/FEAT-001/FEAT-001-test.patch
 ./vendor/bin/phpunit
 git add .
 git commit -m "test: add tests for login feature (FEAT-001)"
@@ -411,9 +475,9 @@ git commit -m "test: add tests for login feature (FEAT-001)"
 
 ```bash
 /ps.6-analyze \
-  prompt-suite/specs/FEAT-001/FEAT-001-requirement.md \
-  prompt-suite/specs/FEAT-001/FEAT-001-design.md \
-  prompt-suite/specs/FEAT-001/FEAT-001-test.md
+  prompt-suite/tasks/FEAT-001/FEAT-001-requirement.md \
+  prompt-suite/tasks/FEAT-001/FEAT-001-design.md \
+  prompt-suite/tasks/FEAT-001/FEAT-001-test.md
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prompt-suite",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Prompt Suite - Prompt Engineering & Workflow Automation",
   "main": "index.js",
   "bin": {

package/{flows → prompts}/ps.0-gen-rules.prompt.md

@@ -5,9 +5,11 @@ description: Initialize workflow rules for project (requirement, design, code, t
 # /ps.0-gen-rules
 
 ## Description
+
 Create workflow rules for all SDLC steps. Each step has 2 rules: gen-rule (for generation) and rev-rule (for review).
 
 **Steps covered:**
+
 - Step 1: Requirement (how to write & review requirements)
 - Step 2: Design (how to write & review technical designs)
 - Step 3: Code (how to write & review code)
@@ -17,9 +19,10 @@ Create workflow rules for all SDLC steps. Each step has 2 rules: gen-rule (for g
 ## Input Requirements
 
 **Input Type: File Path (Required)**
+
 - Provides path to a text file containing Step, Stack, Architecture, etc.
 - **File can be located anywhere** (not limited to `/prompt-suite`)
-- Template file available at: `/prompt-suite/templates/gen-rule-template.txt`
+- Template file available at: `/prompt-suite/tasks/templates/gen-rule-template.md`
 - Format inside file:
   ```text
   Step: ...
@@ -48,11 +51,13 @@ Create workflow rules for all SDLC steps. Each step has 2 rules: gen-rule (for g
 ## Output Format
 
 ### Output Location:
+
 - **Base directory**: `<repo_root>/prompt-suite/rules/`
 - **Auto-creation**: Directory will be created automatically if it doesn't exist
 - **File handling**: Existing files will be overwritten. **Review carefully before running.**
 
 ### Rules Structure:
+
 ```
 /prompt-suite/rules/
 ├── ps.1-gen-requirement.rule.md
@@ -70,6 +75,7 @@ Create workflow rules for all SDLC steps. Each step has 2 rules: gen-rule (for g
 ### Rule Content by Step:
 
 **Step 1 (Requirement):**
+
 - `ps.1-gen-requirement.rule.md`: Guidelines for converting raw request → requirement document
   - What to include, what to avoid
   - Template structure requirements
@@ -82,6 +88,7 @@ Create workflow rules for all SDLC steps. Each step has 2 rules: gen-rule (for g
   - Common mistakes to catch
 
 **Step 2 (Design):**
+
 - `ps.2-gen-design.rule.md`: Guidelines for creating tech design from requirement
   - Architecture principles (Clean Architecture, etc.)
   - Security requirements
@@ -94,6 +101,7 @@ Create workflow rules for all SDLC steps. Each step has 2 rules: gen-rule (for g
   - Implementation feasibility
 
 **Step 3 (Code):**
+
 - `ps.3-gen-code.rule.md`: Coding standards and conventions
   - Backend/Frontend coding rules
   - Layer separation
@@ -106,6 +114,7 @@ Create workflow rules for all SDLC steps. Each step has 2 rules: gen-rule (for g
   - Test coverage requirements
 
 **Step 4 (Test Plan):**
+
 - `ps.4-gen-test-plan.rule.md`: Guidelines for creating test plans
   - Test level strategy (unit/integration/E2E)
   - Coverage requirements
@@ -118,6 +127,7 @@ Create workflow rules for all SDLC steps. Each step has 2 rules: gen-rule (for g
   - Feasibility assessment
 
 **Step 5 (Test Code):**
+
 - `ps.5-gen-test-code.rule.md`: Test code writing standards
   - Test structure conventions
   - Assertion best practices
@@ -182,8 +192,8 @@ COMMON REQUIREMENTS (apply to ALL steps):
 3. Examples (Good vs Bad) with real code/content
 4. Common mistakes to avoid
 5. **CRITICAL**: In Section 3 (Project Structure), you MUST document the explicit paths to key directories (e.g., `src/`, `app/`, `tests/`). This allows future AI steps to find files automatically.
-6. Follow the template EXACTLY: Principles → Architecture & Boundaries → Project Structure → 
-   Implementation Rules → Error Handling & Logging → Testing Rules → Security → 
+6. Follow the template EXACTLY: Principles → Architecture & Boundaries → Project Structure →
+   Implementation Rules → Error Handling & Logging → Testing Rules → Security →
    PR Checklist → Examples
 
 **Every rev-rule file MUST include:**
@@ -241,57 +251,70 @@ SELF-CHECK BEFORE OUTPUT:
 3. Verify all 9 sections are present in every file.
 ```
 
-## Template for each *-rule.md
+## Template for each \*-rule.md
 
-```markdown
+````markdown
 # {Rule Name}
 
 ## 1) Principles
+
 - MUST:
 - SHOULD:
 - SHOULD NOT:
 
 ## 2) Architecture & Boundaries
+
 - Allowed dependencies:
 - Forbidden dependencies:
 
 ## 3) Project Structure
+
 - **Root Directories** (CRITICAL: Must specify absolute or relative paths from repo root):
 - Folders structure:
 - Naming conventions:
 
 ## 4) Implementation Rules
+
 - Patterns:
 - Anti-patterns:
 
 ## 5) Error Handling & Logging
+
 - Rules:
 - Examples:
 
 ## 6) Testing Rules
+
 - Unit:
 - Integration:
 - E2E:
 
 ## 7) Security (if applicable)
+
 - Rules:
 - Examples:
 
 ## 8) PR Checklist
+
 - [ ] ...
 - [ ] ...
 
 ## 9) Examples
+
 ### Good
+
 ```txt
 ...
 ```
+````
 
 ### Bad
+
 ```txt
 ...
 ```
-```
+
+````
 
 ## Rules/Guidelines
 1. ✅ Rules must be **practical** - can be applied immediately
@@ -306,11 +329,12 @@ SELF-CHECK BEFORE OUTPUT:
 ```bash
 /ps.0-gen-rules /path/to/my-project-rules.txt
 # → Generates all 10 files in /prompt-suite/rules/ (step1-5, each with gen + rev)
-```
+````
 
 ⚠️ **Warning**: This will overwrite existing rule files. Commit your changes first!
 
 ### Example 2: Generate only step 1 rules (Requirement)
+
 ```bash
 # In your input file: Step: 1
 /ps.0-gen-rules /path/to/step1-rules.txt
@@ -318,6 +342,7 @@ SELF-CHECK BEFORE OUTPUT:
 ```
 
 ### Example 3: Generate step 2 rules (Design)
+
 ```bash
 # In your input file: Step: 2
 /ps.0-gen-rules /path/to/step2-rules.txt
@@ -325,6 +350,7 @@ SELF-CHECK BEFORE OUTPUT:
 ```
 
 ### Example 4: Generate step 3 rules (Code) in Vietnamese
+
 ```bash
 # In your input file: Language: vi
 /ps.0-gen-rules /path/to/step3-vi-rules.txt
@@ -332,4 +358,5 @@ SELF-CHECK BEFORE OUTPUT:
 ```
 
 ## Next Steps
+
 After generating workflow rules → run `/ps.0-rev-rules` to review and improve

package/{flows → prompts}/ps.1-gen-requirement.prompt.md

@@ -11,6 +11,7 @@ Convert raw customer request into a structured, clear, and testable requirement
 ## Input Requirements
 
 **Input Type: File Path (Required)**
+
 - Provides path to a text file containing Task ID, Language, and Raw Request.
 - **File can be located anywhere** (e.g., `~/Desktop/request.txt`, `/tmp/my-task.txt`).
 - **Filename**: Flexible naming, but meaningful names recommended (e.g., `FEAT-001-request.txt`).
@@ -23,13 +24,16 @@ Convert raw customer request into a structured, clear, and testable requirement
 - AI will automatically read the file.
 
 **Task Mode (Optional, Default: NEW)**
-- `NEW`: New feature request.
+
+- `NEW`: New task request.
 - `UPDATE`: Request to update/refactor existing functionality.
 
 **Existing Logic/Code (Required for UPDATE)**
+
 - If Mode is `UPDATE`, provide current business rules or code snippets to be modified.
 
 **Rule File** (optional but recommended):
+
 - `ps.1-gen-requirement.rule.md` from `/prompt-suite/rules/` - Guidelines for generating requirements
 
 ## Input Validation
@@ -44,18 +48,18 @@ Convert raw customer request into a structured, clear, and testable requirement
 
 File markdown: `{#task-id}-requirement.md`
 
-**Folder Structure**: All feature artifacts must be stored in:
+**Folder Structure**: All task artifacts must be stored in:
 
 ```
-/prompt-suite/specs/{#task-id}/
+/prompt-suite/tasks/{#task-id}/
 ├── {#task-id}-requirement.md
 ├── {#task-id}-design.md
 ├── {#task-id}-test.md
-├── {#task-id}-feature.patch
+├── {#task-id}-code.patch
 └── {#task-id}-test.patch
 ```
 
-Example: `/prompt-suite/specs/FEAT-001/FEAT-001-requirement.md`
+Example: `/prompt-suite/tasks/FEAT-001/FEAT-001-requirement.md`
 
 ## Template
 
@@ -68,6 +72,7 @@ Example: `/prompt-suite/specs/FEAT-001/FEAT-001-requirement.md`
 **Date**: {YYYY-MM-DD}
 **From**: {Customer/Stakeholder name}
 ```
+
 {Paste exact original request here - keep verbatim}
 
 ```
@@ -155,7 +160,7 @@ INSTRUCTIONS:
      - Focus on "What changes" vs "What remains".
      - In "Scope", explicitly list what is preserved.
    - **IF Mode is NEW**:
-     - Focus on complete new feature definition.
+     - Focus on complete new task definition.
 
 2. **Parse Information**:
    - Extract **Task ID**.