sdd-workflow 1.1.0

package/templates/specify/scripts/create-feature.sh

@@ -0,0 +1,144 @@
+#!/bin/bash
+# SDD Feature Creator
+# Creates a new feature specification directory
+
+set -e
+
+# Color definitions
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# Get .specify directory
+SPECIFY_DIR="$(cd "$(dirname "$0")/.." && pwd)"
+SPECS_DIR="$SPECIFY_DIR/specs"
+TEMPLATES_DIR="$SPECIFY_DIR/templates"
+
+# Check directory exists
+if [ ! -d "$SPECIFY_DIR" ]; then
+    echo -e "${RED}Error: .specify directory does not exist${NC}"
+    exit 1
+fi
+
+# Get next feature ID
+get_next_feature_id() {
+    local max_id=0
+    for dir in "$SPECS_DIR"/*/; do
+        if [ -d "$dir" ]; then
+            dirname=$(basename "$dir")
+            id=$(echo "$dirname" | grep -o '^[0-9]*' || echo "0")
+            if [ "$id" -gt "$max_id" ] 2>/dev/null; then
+                max_id=$id
+            fi
+        fi
+    done
+    printf "%03d" $((max_id + 1))
+}
+
+# Create feature directory
+create_feature() {
+    local feature_name=$1
+    local feature_id=$(get_next_feature_id)
+    local feature_dir="$SPECS_DIR/${feature_id}-${feature_name}"
+
+    # Check if directory already exists
+    if [ -d "$feature_dir" ]; then
+        echo -e "${RED}Error: Feature directory already exists: $feature_dir${NC}"
+        exit 1
+    fi
+
+    # Create directory
+    mkdir -p "$feature_dir/contracts"
+
+    # Get current date
+    local date=$(date +%Y-%m-%d)
+
+    # Create spec.md
+    if [ -f "$TEMPLATES_DIR/spec-template.md" ]; then
+        sed -e "s/{feature_id}/$feature_id/g" \
+            -e "s/{date}/$date/g" \
+            -e "s/{feature_name}/$feature_name/g" \
+            "$TEMPLATES_DIR/spec-template.md" > "$feature_dir/spec.md"
+    else
+        touch "$feature_dir/spec.md"
+    fi
+
+    # Create plan.md
+    if [ -f "$TEMPLATES_DIR/plan-template.md" ]; then
+        sed -e "s/{feature_id}/$feature_id/g" \
+            -e "s/{date}/$date/g" \
+            "$TEMPLATES_DIR/plan-template.md" > "$feature_dir/plan.md"
+    else
+        touch "$feature_dir/plan.md"
+    fi
+
+    # Create tasks.md
+    if [ -f "$TEMPLATES_DIR/tasks-template.md" ]; then
+        sed -e "s/{feature_id}/$feature_id/g" \
+            -e "s/{date}/$date/g" \
+            "$TEMPLATES_DIR/tasks-template.md" > "$feature_dir/tasks.md"
+    else
+        touch "$feature_dir/tasks.md"
+    fi
+
+    echo -e "${GREEN}Feature directory created: $feature_dir${NC}"
+    echo ""
+    echo "File structure:"
+    echo "  ${feature_id}-${feature_name}/"
+    echo "  ├── spec.md          # Feature specification"
+    echo "  ├── plan.md          # Technical plan"
+    echo "  ├── tasks.md         # Task breakdown"
+    echo "  └── contracts/       # API contracts"
+    echo ""
+    echo "Next steps:"
+    echo "  1. Use /sdd-specify to complete the feature specification"
+    echo "  2. Use /sdd-plan to create the technical plan"
+    echo "  3. Use /sdd-tasks to break down tasks"
+}
+
+# List existing features
+list_features() {
+    echo -e "${YELLOW}Existing features:${NC}"
+    echo ""
+    for dir in "$SPECS_DIR"/*/; do
+        if [ -d "$dir" ]; then
+            dirname=$(basename "$dir")
+            echo "  - $dirname"
+        fi
+    done
+}
+
+# Help information
+show_help() {
+    echo "SDD Feature Creator"
+    echo ""
+    echo "Usage:"
+    echo "  $0 <feature-name>    Create new feature directory"
+    echo "  $0 list              List existing features"
+    echo "  $0 help              Show help"
+    echo ""
+    echo "Examples:"
+    echo "  $0 user-authentication"
+    echo "  $0 data-export"
+    echo "  $0 notification-system"
+}
+
+# Main logic
+case "$1" in
+    ""|help|--help|-h)
+        show_help
+        ;;
+    list|--list|-l)
+        list_features
+        ;;
+    *)
+        # Validate feature name format
+        if [[ ! "$1" =~ ^[a-z][a-z0-9-]*$ ]]; then
+            echo -e "${RED}Error: Feature name must be lowercase letters, numbers and hyphens, starting with a letter${NC}"
+            echo "Examples: user-authentication, data-export, notification-system"
+            exit 1
+        fi
+        create_feature "$1"
+        ;;
+esac

package/templates/specify/templates/constitution-template.md

@@ -0,0 +1,74 @@
+# 项目宪法 (Constitution)
+
+> 项目基本信息、技术栈、环境配置见项目根目录 CLAUDE.md，本文档仅记录**开发约束和原则**。
+> 创建日期: {date}
+> 最后更新: {date}
+
+---
+
+## 一、绝对铁律
+
+1. {iron_rule_1}
+
+---
+
+## 二、开发原则
+
+### 2.1 简单性原则
+
+> **优先复用现有方法，避免重复造轮子**
+
+新增代码前必须检查：是否已有类似方法？是否可扩展现有方法？是否有更底层的公共方法？
+
+### 2.2 N+1 查询禁令
+
+禁止在循环内执行数据库查询，使用批量查询 + Map 缓存替代。
+
+### 2.3 代码质量
+
+{code_quality_principles}
+
+### 2.4 测试标准
+
+{testing_standards}
+
+---
+
+## 三、架构约束
+
+<!-- SDD 自动检测技术栈，填入 constitution.md 中的实际值。
+     支持任意架构模式，以下为常见模式示例，请根据项目实际情况选择或替换。 -->
+
+### 3.1 架构模式
+
+> 检测到的架构模式: `{architecture_pattern}`
+> 前端技术栈: `{frontend_stack}`
+> 后端技术栈: `{backend_stack}`
+> 数据库: `{database}`
+
+{architecture_principles}
+
+### 3.2 API 响应格式
+
+{api_response_format}
+
+---
+
+## 四、SDD 文档职责边界
+
+| 文档 | 职责 | 内容边界 |
+|------|------|----------|
+| spec.md | What | 业务需求、用户故事、验收标准。禁止 SQL/代码/文件路径 |
+| testcases.md | 行为验证 | 测试场景 Given-When-Then |
+| plan.md | How | 技术方案、架构设计、代码设计 |
+| tasks.md | When | 任务分解、执行顺序、进度跟踪 |
+
+---
+
+## 五、经验教训
+
+{lessons_learned}
+
+---
+
+*本文档由 SDD 规范维护，如需更新请运行 `/sdd-constitution`*

package/templates/specify/templates/plan-modular-template/README.md

@@ -0,0 +1,98 @@
+# {feature_name} - Implementation Plan Index
+
+> Version: {version}
+> Created: {create_date}
+> Updated: {update_date}
+> Related Spec: [spec.md](../spec.md)
+> Related Test Cases: [testcases.md](../testcases.md)
+
+## Document Structure
+
+The implementation plan has been split into the following modules for easier management and on-demand loading:
+
+```
+plan/
+├── README.md              # This file - plan index and overview
+├── architecture.md        # Architecture design
+├── data-model.md          # Data model (DDL, DTO)
+├── backend-api.md         # Backend API design
+├── backend-impl.md        # Backend implementation details
+├── frontend-api.md        # Frontend API integration
+├── frontend-impl.md       # Frontend implementation details
+├── security.md            # Security design
+├── performance.md         # Performance optimization
+└── changelog.md           # Change log
+```
+
+## Document Overview
+
+| Module | Content | Document |
+|--------|---------|----------|
+| Architecture Design | Overall architecture, tech stack, module breakdown | [architecture.md](./architecture.md) |
+| Data Model | DDL, DTO, entity relationships | [data-model.md](./data-model.md) |
+| Backend API | Controller, interface definitions | [backend-api.md](./backend-api.md) |
+| Backend Implementation | Service, Repository implementation | [backend-impl.md](./backend-impl.md) |
+| Frontend API | API integration, request wrapper | [frontend-api.md](./frontend-api.md) |
+| Frontend Implementation | Components, Store, routing | [frontend-impl.md](./frontend-impl.md) |
+| Security | Authentication, authorization, data security | [security.md](./security.md) |
+| Performance Optimization | Caching, indexing, optimization strategies | [performance.md](./performance.md) |
+| Change Log | Version change history | [changelog.md](./changelog.md) |
+
+## Quick Navigation
+
+### Core Documents
+- [Architecture Design](./architecture.md) - Understand overall architecture and technology choices
+- [Data Model](./data-model.md) - View database design and DTO definitions
+- [Backend API](./backend-api.md) - View API interface definitions
+
+### Implementation Documents
+- [Backend Implementation](./backend-impl.md) - Backend Service and Repository implementation
+- [Frontend API](./frontend-api.md) - Frontend API integration approach
+- [Frontend Implementation](./frontend-impl.md) - Frontend component and Store implementation
+
+### Auxiliary Documents
+- [Security Design](./security.md) - Security-related design
+- [Performance Optimization](./performance.md) - Performance optimization strategies
+- [Change Log](./changelog.md) - Version change history
+
+## Core Information Summary
+
+### Technology Stack
+
+> Read from constitution.md or project configuration.
+
+| Layer | Technology | Version |
+|-------|-----------|---------|
+| Frontend Framework | {frontend_framework} | {frontend_version} |
+| UI Library | {ui_library} | {ui_version} |
+| State Management | {state_management} | {state_version} |
+| Backend Framework | {backend_framework} | {backend_version} |
+| Database | {database} | {database_version} |
+
+### Architecture Overview
+
+```
+Frontend ({frontend_framework} + {state_management})
+    | HTTP API
+Backend ({backend_framework})
+    | {database_driver}
+Database ({database})
+```
+
+### Key Design Decisions
+
+1. **Decision 1**: {brief_description}
+2. **Decision 2**: {brief_description}
+3. **Decision 3**: {brief_description}
+
+## Usage Guide
+
+1. **View Overview**: Read this file to understand the overall structure
+2. **Architecture First**: Start with [architecture.md](./architecture.md) for overall design
+3. **On-demand Loading**: Open the corresponding module document for your development phase
+4. **Backend Development**: Refer to [backend-api.md](./backend-api.md) and [backend-impl.md](./backend-impl.md)
+5. **Frontend Development**: Refer to [frontend-api.md](./frontend-api.md) and [frontend-impl.md](./frontend-impl.md)
+
+---
+
+*This document follows SDD specification and includes technical implementation details (SQL, code, file paths)*

package/templates/specify/templates/plan-modular-template/architecture.md

@@ -0,0 +1,127 @@
+# Architecture Design
+
+> This document describes overall architecture, technology stack and module breakdown
+
+## 1. Overall Architecture
+
+### 1.1 Architecture Diagram
+
+```
+┌─────────────────────────────────────────────────────────────────────────┐
+│                              Frontend                                    │
+├─────────────────────────────────────────────────────────────────────────┤
+│  Page Layer                                                              │
+│  ├── Page Components ({component_framework})                            │
+│  ├── Route Configuration ({router})                                     │
+│  └── Styles ({style_solution})                                          │
+├─────────────────────────────────────────────────────────────────────────┤
+│  State Management Layer                                                  │
+│  ├── Store ({state_management})                                         │
+│  └── Actions                                                            │
+├─────────────────────────────────────────────────────────────────────────┤
+│  API Service Layer                                                       │
+│  ├── API Wrapper                                                        │
+│  └── Request Interceptors                                               │
+└──────────────────────────────────────┬──────────────────────────────────┘
+                                       │ HTTP API
+┌──────────────────────────────────────▼──────────────────────────────────┐
+│                              Backend                                     │
+├─────────────────────────────────────────────────────────────────────────┤
+│  Controller/Handler Layer                                               │
+│  ├── REST API                                                           │
+│  └── Parameter Validation                                               │
+├─────────────────────────────────────────────────────────────────────────┤
+│  Service Layer                                                          │
+│  ├── Business Logic                                                    │
+│  └── Transaction Management                                             │
+├─────────────────────────────────────────────────────────────────────────┤
+│  Repository/Data Access Layer                                           │
+│  ├── Data Access                                                        │
+│  └── Query Mapping                                                      │
+└──────────────────────────────────────┬──────────────────────────────────┘
+                                       │ {database_driver}
+┌──────────────────────────────────────▼──────────────────────────────────┐
+│                          Database ({database})                          │
+└─────────────────────────────────────────────────────────────────────────┘
+```
+
+### 1.2 Technology Stack
+
+> Read technology stack information from constitution.md or project configuration.
+
+| Layer | Technology | Version | Notes |
+|-------|-----------|---------|-------|
+| Frontend Framework | {frontend_framework} | {frontend_version} | {frontend_notes} |
+| UI Library | {ui_library} | {ui_version} | {ui_notes} |
+| State Management | {state_management} | {state_version} | {state_notes} |
+| Backend Framework | {backend_framework} | {backend_version} | {backend_notes} |
+| ORM Framework | {orm_framework} | {orm_version} | {orm_notes} |
+| Database | {database} | {database_version} | {database_notes} |
+
+### 1.3 Module Breakdown
+
+**Frontend Modules**:
+- Page module: Responsible for UI display and user interaction
+- Store module: Responsible for state management and data flow
+- API module: Responsible for backend communication
+
+**Backend Modules**:
+- Controller module: Responsible for interface definition and parameter validation
+- Service module: Responsible for business logic implementation
+- Repository module: Responsible for data access
+
+## 2. Key Design Decisions
+
+### Decision 1: {decision_title}
+
+**Background**: {why this decision is needed}
+
+**Options Comparison**:
+
+| Option | Pros | Cons | Conclusion |
+|--------|------|------|------------|
+| Option A | Pro 1, Pro 2 | Con 1, Con 2 | Not adopted |
+| Option B | Pro 1, Pro 2 | Con 1, Con 2 | Adopted |
+
+**Final Decision**: Adopt Option B
+
+**Rationale**: {detailed explanation of why this option was chosen}
+
+### Decision 2: {decision_title}
+
+{Same format as above}
+
+## 3. Module Dependencies
+
+```
+Frontend Pages -> Frontend Store -> Frontend API -> Backend Controller -> Backend Service -> Backend Repository -> Database
+```
+
+## 4. Interface Design Principles
+
+1. **RESTful Style**: Follow REST conventions
+2. **Unified Response Format**: Use standard response structure
+3. **Version Control**: API paths include version number (/v1/)
+4. **Error Handling**: Unified error codes and error messages
+
+## 5. Data Flow Design
+
+### 5.1 Query Flow
+
+```
+User Action -> Page Component -> Store.action -> API Request -> Controller -> Service -> Repository -> Database
+                                                                              |
+User Interface <- Page Component <- Store.state <- API Response <- Controller <- Service <- Repository <- Query Result
+```
+
+### 5.2 Save Flow
+
+```
+User Action -> Page Component -> Store.action -> API Request -> Controller -> Service -> Repository -> Database
+                                                    |           |
+                                                Validation   Business Check
+```
+
+---
+
+Back to [Plan Index](./README.md)

package/templates/specify/templates/plan-modular-template/backend-api.md

@@ -0,0 +1,191 @@
+# Backend API Design
+
+> This document describes backend API interface definitions
+
+## 1. API Handler Design
+
+### 1.1 Handler/Controller Class
+
+**File Path**: `{backend_source_path}/controllers/{Name}Controller.{ext}`
+
+```{backend_language}
+// {Name}Controller - API endpoints for {module}/{resource}
+```
+
+## 2. API Interface List
+
+### 2.1 Query Interface
+
+#### GET /v1/{module}/{resource}
+
+**Purpose**: Query list
+
+**Request Parameters**:
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| keyword | String | No | Keyword search |
+| status | String | No | Status filter |
+| pageNum | Integer | No | Page number (default 1) |
+| pageSize | Integer | No | Page size (default 20) |
+
+**Response Example**:
+
+```json
+{
+  "status": "0",
+  "message": "success",
+  "data": {
+    "total": 100,
+    "list": [
+      {
+        "id": "1",
+        "name": "Name",
+        "status": "ACTIVE"
+      }
+    ]
+  }
+}
+```
+
+### 2.2 Detail Interface
+
+#### GET /v1/{module}/{resource}/{id}
+
+**Purpose**: Query detail
+
+**Path Parameters**:
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| id | Long | Yes | Resource ID |
+
+**Response Example**:
+
+```json
+{
+  "status": "0",
+  "message": "success",
+  "data": {
+    "id": "1",
+    "name": "Name",
+    "description": "Description"
+  }
+}
+```
+
+### 2.3 Create Interface
+
+#### POST /v1/{module}/{resource}
+
+**Purpose**: Create resource
+
+**Request Body**:
+
+```json
+{
+  "name": "Name",
+  "description": "Description"
+}
+```
+
+**Response Example**:
+
+```json
+{
+  "status": "0",
+  "message": "Created successfully",
+  "data": {
+    "id": "1"
+  }
+}
+```
+
+### 2.4 Update Interface
+
+#### PUT /v1/{module}/{resource}/{id}
+
+**Purpose**: Update resource
+
+**Path Parameters**:
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| id | Long | Yes | Resource ID |
+
+**Request Body**:
+
+```json
+{
+  "name": "New Name",
+  "description": "New Description"
+}
+```
+
+**Response Example**:
+
+```json
+{
+  "status": "0",
+  "message": "Updated successfully"
+}
+```
+
+### 2.5 Delete Interface
+
+#### DELETE /v1/{module}/{resource}/{id}
+
+**Purpose**: Delete resource
+
+**Path Parameters**:
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| id | Long | Yes | Resource ID |
+
+**Response Example**:
+
+```json
+{
+  "status": "0",
+  "message": "Deleted successfully"
+}
+```
+
+## 3. Unified Response Format
+
+### 3.1 Success Response
+
+```json
+{
+  "status": "0",
+  "message": "success",
+  "data": {}
+}
+```
+
+### 3.2 Error Response
+
+```json
+{
+  "status": "1",
+  "message": "Error message",
+  "data": null
+}
+```
+
+## 4. Error Code Definitions
+
+| Error Code | Description | HTTP Status |
+|------------|-------------|-------------|
+| 0 | Success | 200 |
+| 1 | Business error | 200 |
+| 400 | Parameter error | 400 |
+| 401 | Unauthorized | 401 |
+| 403 | Forbidden | 403 |
+| 404 | Not found | 404 |
+| 500 | Server error | 500 |
+
+---
+
+Back to [Plan Index](./README.md)