@zhuan-ai/zhuanspec 2.0.0 → 2.1.1

package/schemas/tdd/schema.yaml

@@ -1,177 +1,177 @@
 name: tdd
 version: 1
-description: Test-driven development workflow - tests → implementation → docs
+description: 测试驱动开发工作流 - 测试 → 实现 → 文档
 artifacts:
   - id: spec
     generates: spec.md
-    description: Feature specification defining requirements
+    description: 定义需求的特性规格说明
     template: spec.md
     instruction: |
-      Create the feature specification that defines WHAT to build.
+      创建定义「要构建什么」的特性规格说明。
 
-      Sections:
-      - **Feature**: Name and high-level description of the feature's purpose and user value
-      - **Requirements**: List of specific requirements. Use SHALL/MUST for normative language.
-      - **Acceptance Criteria**: Testable criteria in WHEN/THEN format
+      章节：
+      - **Feature**: 特性名称及高层描述，说明其用途和用户价值
+      - **Requirements**: 具体需求列表。使用 SHALL/MUST 作为规范性语言。
+      - **Acceptance Criteria**: 使用 WHEN/THEN 格式的可测试验收标准
 
-      Format requirements:
-      - Each requirement should be specific and testable
-      - Use `#### Scenario: <name>` with WHEN/THEN format for acceptance criteria
-      - Define edge cases and error scenarios explicitly
-      - Every requirement MUST have at least one scenario
+      格式要求：
+      - 每个需求应具体且可测试
+      - 使用 `#### Scenario: <名称>` 配合 WHEN/THEN 格式编写验收标准
+      - 明确定义边界情况和错误场景
+      - 每个需求必须至少有一个场景
 
-      Example:
+      示例：
       ```
-      ## Feature: User Authentication
+      ## Feature: 用户认证
 
-      Users can securely log into the application.
+      用户可以安全地登录应用程序。
 
       ## Requirements
 
-      ### Requirement: Password validation
-      The system SHALL validate passwords meet minimum security requirements.
+      ### Requirement: 密码验证
+      系统 SHALL 验证密码满足最低安全要求。
 
-      #### Scenario: Valid password accepted
-      - **WHEN** password has 8+ chars, uppercase, lowercase, and number
-      - **THEN** password is accepted
+      #### Scenario: 有效密码被接受
+      - **WHEN** 密码包含 8+ 字符、大写字母、小写字母和数字
+      - **THEN** 密码被接受
 
-      #### Scenario: Weak password rejected
-      - **WHEN** password is less than 8 characters
-      - **THEN** system displays "Password too short" error
+      #### Scenario: 弱密码被拒绝
+      - **WHEN** 密码少于 8 个字符
+      - **THEN** 系统显示 "Password too short" 错误
       ```
 
-      This spec drives test creation - each scenario becomes a test case.
+      此规格驱动测试创建 - 每个场景成为一个测试用例。
     requires: []
 
   - id: tests
     generates: "tests/*.test.ts"
-    description: Test files written before implementation
+    description: 在实现之前编写的测试文件
     template: test.md
     instruction: |
-      Write tests BEFORE implementation (TDD red phase).
-
-      File naming:
-      - Create test files as `tests/<feature>.test.ts`
-      - One test file per feature/capability
-      - Use descriptive names matching the spec
-
-      Test structure:
-      - Use Given/When/Then format matching spec scenarios
-      - Group related tests with `describe()` blocks
-      - Each scenario from spec becomes at least one `it()` test
-
-      Coverage requirements:
-      - Cover each requirement from the spec
-      - Include happy path (success cases)
-      - Include edge cases (boundary conditions)
-      - Include error scenarios (invalid input, failures)
-      - Tests should fail initially (no implementation yet)
-
-      Example:
+      在实现之前编写测试（TDD 红阶段）。
+
+      文件命名：
+      - 创建测试文件为 `tests/<feature>.test.ts`
+      - 每个特性/能力一个测试文件
+      - 使用与规格匹配的描述性名称
+
+      测试结构：
+      - 使用与规格场景匹配的 Given/When/Then 格式
+      - 使用 `describe()` 块分组相关测试
+      - 规格中的每个场景至少成为一个 `it()` 测试
+
+      覆盖要求：
+      - 覆盖规格中的每个需求
+      - 包含正常路径（成功场景）
+      - 包含边界情况（边界条件）
+      - 包含错误场景（无效输入、失败）
+      - 测试最初应该失败（还没有实现）
+
+      示例：
       ```typescript
       describe('Password validation', () => {
         it('accepts valid password with all requirements', () => {
-          // GIVEN a password meeting all requirements
+          // GIVEN 一个满足所有要求的密码
           const password = 'SecurePass1';
-          // WHEN validating
+          // WHEN 进行验证
           const result = validatePassword(password);
-          // THEN it should be accepted
+          // THEN 应该被接受
           expect(result.valid).toBe(true);
         });
 
         it('rejects password shorter than 8 characters', () => {
-          // GIVEN a short password
+          // GIVEN 一个短密码
           const password = 'Short1';
-          // WHEN validating
+          // WHEN 进行验证
           const result = validatePassword(password);
-          // THEN it should be rejected with message
+          // THEN 应该被拒绝并显示消息
           expect(result.valid).toBe(false);
           expect(result.error).toBe('Password too short');
         });
       });
       ```
 
-      Follow the spec requirements exactly - tests verify the spec.
+      严格遵循规格需求 - 测试验证规格。
     requires:
       - spec
 
   - id: implementation
     generates: "src/*.ts"
-    description: Implementation code to pass the tests
+    description: 使测试通过的实现代码
     template: implementation.md
     instruction: |
-      Implement the feature to make tests pass (TDD green phase).
-
-      TDD workflow:
-      1. Run tests - confirm they fail (red)
-      2. Write minimal code to pass ONE test
-      3. Run tests - confirm that test passes (green)
-      4. Refactor if needed while keeping tests green
-      5. Repeat for next failing test
-
-      Implementation guidelines:
-      - Write minimal code to pass each test - no more, no less
-      - Run tests frequently to verify progress
-      - Keep functions small and focused
-      - Use clear, descriptive names
-
-      Code organization:
-      - Create source files in `src/<feature>.ts`
-      - Export public API clearly
-      - Keep implementation details private
-      - Add JSDoc comments for public functions
-
-      Example structure:
+      实现特性以使测试通过（TDD 绿阶段）。
+
+      TDD 工作流：
+      1. 运行测试 - 确认它们失败（红）
+      2. 编写最小代码通过一个测试
+      3. 运行测试 - 确认该测试通过（绿）
+      4. 如有需要重构，同时保持测试通过
+      5. 对下一个失败的测试重复上述步骤
+
+      实现指南：
+      - 编写最小代码通过每个测试 - 不多不少
+      - 频繁运行测试以验证进度
+      - 保持函数小而专注
+      - 使用清晰、描述性的名称
+
+      代码组织：
+      - 在 `src/<feature>.ts` 中创建源文件
+      - 清晰导出公共 API
+      - 保持实现细节私有
+      - 为公共函数添加 JSDoc 注释
+
+      示例结构：
       ```typescript
       /**
-       * Validates a password meets security requirements.
-       * @param password - The password to validate
-       * @returns Validation result with valid flag and optional error
+       * 验证密码是否满足安全要求。
+       * @param password - 要验证的密码
+       * @returns 验证结果，包含有效标志和可选错误信息
        */
       export function validatePassword(password: string): ValidationResult {
         if (password.length < 8) {
           return { valid: false, error: 'Password too short' };
         }
-        // ... additional checks
+        // ... 额外的检查
         return { valid: true };
       }
       ```
 
-      Don't over-engineer - implement only what tests require.
+      不要过度设计 - 只实现测试要求的内容。
     requires:
       - tests
 
   - id: docs
     generates: "docs/*.md"
-    description: Documentation for the implemented feature
+    description: 已实现特性的文档
     template: docs.md
     instruction: |
-      Document the implemented feature.
-
-      Sections:
-      - **Overview**: What the feature does and why it exists (1-2 paragraphs)
-      - **Getting Started**: Quick start guide to use the feature immediately
-      - **Examples**: Code examples showing common use cases
-      - **Reference**: Detailed API documentation, configuration options
-
-      Guidelines:
-      - Write for the user, not the developer
-      - Start with the most common use case
-      - Include copy-pasteable code examples
-      - Document all configuration options with defaults
-      - Note any limitations, edge cases, or gotchas
-      - Link to related features or specs
-
-      Example structure:
+      为已实现的特性编写文档。
+
+      章节：
+      - **Overview**: 特性功能及存在原因（1-2 段落）
+      - **Getting Started**: 立即使用该特性的快速入门指南
+      - **Examples**: 展示常见用例的代码示例
+      - **Reference**: 详细的 API 文档、配置选项
+
+      指南：
+      - 为用户编写，而非开发者
+      - 从最常见的用例开始
+      - 包含可复制粘贴的代码示例
+      - 记录所有配置选项及其默认值
+      - 注意任何限制、边界情况或注意事项
+      - 链接到相关特性或规格
+
+      示例结构：
       ```markdown
       ## Overview
 
-      Password validation ensures user passwords meet security requirements
-      before account creation or password changes.
+      密码验证确保用户密码在账户创建或密码更改前
+      满足安全要求。
 
       ## Getting Started
 
-      Import and use the validation function:
+      导入并使用验证函数：
 
       ```typescript
       import { validatePassword } from './password';
@@ -184,10 +184,10 @@ artifacts:
 
       ## Examples
 
-      ### Basic validation
+      ### 基础验证
       ...
 
-      ### Custom error handling
+      ### 自定义错误处理
       ...
 
       ## Reference
@@ -196,12 +196,12 @@ artifacts:
 
       | Parameter | Type | Description |
       |-----------|------|-------------|
-      | password | string | The password to validate |
+      | password | string | 要验证的密码 |
 
       **Returns**: `{ valid: boolean, error?: string }`
       ```
 
-      Reference the spec for requirements, implementation for details.
+      参考规格了解需求，参考实现了解细节。
     requires:
       - implementation
 
@@ -209,5 +209,5 @@ apply:
   requires: [tests]
   tracks: null
   instruction: |
-    Run tests to see failures. Implement minimal code to pass each test.
-    Refactor while keeping tests green.
+    运行测试查看失败。编写最小代码通过每个测试。
+    在保持测试通过的同时进行重构。

package/schemas/tdd/templates/implementation.md

@@ -1,11 +1,11 @@
-## Implementation Notes
+## 实现说明
 
-<!-- Technical implementation details -->
+<!-- 技术实现细节 -->
 
 ## API
 
-<!-- Public API documentation -->
+<!-- 公共 API 文档 -->
 
-## Usage
+## 用法
 
-<!-- Usage examples -->
+<!-- 用法示例 -->

package/schemas/tdd/templates/spec.md

@@ -1,11 +1,11 @@
-## Feature: <!-- feature name -->
+## 功能：<!-- 功能名称 -->
 
-<!-- Feature description -->
+<!-- 功能描述 -->
 
-## Requirements
+## 需求
 
-<!-- List of requirements -->
+<!-- 需求列表 -->
 
-## Acceptance Criteria
+## 验收标准
 
-<!-- List of acceptance criteria -->
+<!-- 验收标准列表 -->

package/schemas/tdd/templates/test.md

@@ -1,11 +1,11 @@
-## Test Plan
+## 测试计划
 
-<!-- Describe the testing strategy -->
+<!-- 描述测试策略 -->
 
-## Test Cases
+## 测试用例
 
-### <!-- Test case name -->
+### <!-- 测试用例名称 -->
 
-- **Given:** <!-- preconditions -->
-- **When:** <!-- action -->
-- **Then:** <!-- expected result -->
+- **假设：** <!-- 前置条件 -->
+- **当：** <!-- 操作 -->
+- **则：** <!-- 预期结果 -->