npm - @chongyan/autospec - Versions diffs - 1.0.1 → 1.0.3 - Mend

@chongyan/autospec 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (595) hide show

package/knowledge/environment/template-registry.md DELETED Viewed

@@ -1,321 +0,0 @@
-# 环境知识模板注册表
-> 定义环境知识的模板类型、来源和输出位置。供 env-sync、env-import、env-validate 命令引用。
->
-> **版本**: v3.0
-> **最后更新**: 2026-03-26
-> **扩展说明**: 新增 design-knowledge/、test-knowledge/、business-knowledge/ 分类
----
-## 模板清单
-### 环境知识模板（原有）
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| middleware | middleware-knowledge.md | env-knowledge/middleware/{name}.md | 基本信息、环境变量、连接代码模板 |
-| component | component-knowledge.md | component-lib/components/{name}/component.md | 基本信息、接口定义、使用示例 |
-| infrastructure | middleware-knowledge.md | env-knowledge/infrastructure/{name}.md | 基本信息、环境变量 |
-### 研发流程模板
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| proposal | product-proposal.md | requirements/{业务域}/{需求}/proposal.md | 背景与价值、目标与范围、业务架构设计、用例业务流程 |
-| design | system-design.md | requirements/{业务域}/{需求}/{系统名}/design.md | 项目背景、业务用例、功能设计（大纲 + 详设）、领域模型 |
-| task | task-breakdown.md | requirements/{业务域}/{需求}/{系统名}/task.md | Meta 信息、Tasks 列表、Progress、Validation |
-| testcase | test-case.md | requirements/{业务域}/{需求}/{系统名}/testcase.md | 测试概要、测试用例、覆盖矩阵、覆盖统计 |
-### API 文档模板（新增）
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| api-overview | api-overview.md | docs/api/{服务名}/overview.md | 接口概述、认证方式、错误码 |
-| api-parameters | api-parameters.md | docs/api/{服务名}/parameters.md | 参数定义、类型说明、校验规则 |
-| api-error-codes | api-error-codes.md | docs/api/{服务名}/error-codes.md | 错误码列表、处理建议 |
-### 规范文档模板
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| coding-style | standards/coding-style.md | standards/coding-style.md | 数据安全、异常处理、多线程、数据库、日志规范 |
-| data-consistency | standards/data-consistency.md | standards/data-consistency.md | 一致性方案、幂等性设计、分布式事务 |
-| code-review | standards/code-review.md | standards/code-review.md | 评审原则、好代码三要素、检查清单 |
-### 设计知识模板
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| product-design | templates/product-proposal.md | design-knowledge/product/{name}.md | 背景与价值、目标与范围、业务架构设计 |
-| architecture | templates/system-design.md | design-knowledge/architecture/{name}.md | 项目背景、业务用例、功能设计、UML图 |
-| api-design | templates/api-design.md | design-knowledge/api/{name}.md | 接口概述、参数定义、错误码 |
-| database | templates/database-design.md | design-knowledge/database/{name}.md | ER图、表结构、索引设计 |
-### 测试知识模板
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| test-design | templates/test-case.md | test-knowledge/test-designs/{name}.md | 测试概要、测试用例、覆盖矩阵 |
-| evaluation | templates/ai-evaluation.md | test-knowledge/evaluation/{name}.md | 评测目标、数据集、指标、Badcase分析 |
-### 业务知识模板（新增）
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| glossary | domain/glossary.md | business-knowledge/glossary.md | 术语、定义、适用场景 |
-| business-rules | domain/rules.md | business-knowledge/rules.md | 规则ID、规则名称、规则描述、适用场景 |
-| business-flow | domain/flows/README.md | business-knowledge/flows/{name}-flow.md | 流程名称、Mermaid图、说明 |
-### DDD 模板（新增）
-| 模板名称 | 来源文件 | 输出位置 | 必填章节 |
-|---------|---------|---------|---------|
-| domain-driven-design | templates/domain-driven-design.md | design-knowledge/ddd/{name}-ddd.md | 领域识别、限界上下文、聚合设计 |
-**DDD模板适用场景**：
-- 复杂业务系统（业务概念 > 20个）
-- 核心业务建模
-- 微服务边界划分
-- 需要跨团队协作的项目
----
-## 模板分类
-| 分类 | 说明 | 模板列表 |
-|------|------|---------|
-| `environment/` | 环境知识模板 | middleware, component, infrastructure |
-| `design-knowledge/` | 设计知识模板 | product-design, architecture, api-design, database, domain-driven-design |
-| `test-knowledge/` | 测试知识模板 | test-design, evaluation |
-| `business-knowledge/` | 业务知识模板 | glossary, business-rules, business-flow |
-| `standards/` | 规范文档模板 | coding-style, data-consistency, code-review |
-| `ddd/` | DDD领域驱动设计模板 | domain-driven-design |
----
-## 类型枚举
-### 中间件类型
-| 类型 | 说明 | 典型示例 |
-|------|------|---------|
-| relational-database | 关系型数据库 | MySQL, PostgreSQL, Oracle |
-| document-database | 文档数据库 | MongoDB, CouchDB |
-| cache | 缓存 | Redis, Memcached |
-| message-queue | 消息队列 | Kafka, RabbitMQ, RocketMQ |
-| search-engine | 搜索引擎 | Elasticsearch, Solr |
-| vector-store | 向量存储 | Milvus, Pinecone, Weaviate |
-| object-storage | 对象存储 | OSS, S3, MinIO |
-### 组件类型
-| 类型 | 说明 | 典型示例 |
-|------|------|---------|
-| service-component | 服务组件，封装外部服务调用 | 认证组件、支付网关 |
-| utility | 工具组件，提供通用功能 | 日志组件、配置组件 |
-| library | 库组件，封装业务逻辑 | 领域模型、数据访问层 |
----
-## 必填章节定义
-### development 模板必填章节
-#### proposal 模板
-| 章节 | 说明 |
-|------|------|
-| 1. 背景与价值 | 业务背景、业务价值 |
-| 2. 目标与范围 | 目标 (Success Criteria)、范围 (包含/不包含) |
-| 3. 业务架构设计 | 总体架构图、需求用例图、用例业务流程 |
-#### design 模板
-| 章节 | 说明 |
-|------|------|
-| 1. 项目背景 | 目标、参与人、相关文档 |
-| 2. 业务用例 | Mermaid flowchart |
-| 3. 功能设计 | 功能点列表、详细设计（两步生成） |
-#### task 模板
-| 章节 | 说明 |
-|------|------|
-| Meta | design 路径、system 引用 |
-| Tasks | 任务列表（Goal/Depends/Files/Done when） |
-| Progress | 进度跟踪 |
-#### testcase 模板
-| 章节 | 说明 |
-|------|------|
-| 1. 测试概要 | 需求、系统、来源、用例统计 |
-| 3. 测试用例 | 正向/异常/边界/幂等/回归场景 |
-| 5. 覆盖统计 | 各优先级用例数量统计 |
-### middleware 模板必填章节
-| 章节 | 说明 |
-|------|------|
-| 基本信息 | 名称、类型、默认端口、知识版本 |
-| 环境变量 | 必需变量表格、可选变量表格 |
-| 连接代码模板 | Node.js、Python 等语言的连接代码 |
-### component 模板必填章节
-| 章节 | 说明 |
-|------|------|
-| 基本信息 | 名称、类型、版本、维护者 |
-| 接口定义 | 方法名、输入参数、输出参数、错误码 |
-| 使用示例 | 安装命令、代码示例 |
-### standards 模板必填章节
-#### coding-style 模板
-| 章节 | 说明 |
-|------|------|
-| 数据安全 | 一锁二判三更新、金额计算规范 |
-| 异常处理 | 异步方法异常捕获、禁止空 catch |
-| 多线程 | ThreadLocal 清理、线程池规范 |
-| 数据库 | 禁止 SELECT *、参数化查询 |
-| 日志规范 | LogUtil 使用、日志级别 |
-#### data-consistency 模板
-| 章节 | 说明 |
-|------|------|
-| 一致性方案 | 分布式事务、中间态 + 重试、消息队列 |
-| 幂等性设计 | 唯一索引、分布式锁、Token 机制、状态机 |
-| 分布式事务 | 2PC、SAGA 模式 |
-#### code-review 模板
-| 章节 | 说明 |
-|------|------|
-| 评审原则 | 24 小时响应、不苛求完美、正向激励 |
-| 好代码三要素 | 可读性、可靠性、可扩展性 |
-| 检查清单 | 可读性检查、可靠性检查、可扩展性检查 |
----
-## 同步策略
-### 环境知识同步（middleware/component）
-**首次同步**:
-1. 复制 `detection-patterns.yaml` 到本地
-2. 扫描依赖文件、代码模式、环境变量
-3. 按 MD 模板生成知识文件
-4. 校验必填章节完整性
-5. 注册到 registry.json
-**增量同步**:
-1. 扫描变更的依赖和代码
-2. 对比已有知识文件
-3. 仅更新变更项
-4. 校验后更新注册表
-### 研发模板同步（proposal/design/task/testcase）
-**模板加载**:
-1. 从 `knowledge/templates/` 读取模板文件
-2. 解析模板中的占位符（如 `{需求名称}`）
-3. 根据用户输入填充占位符
-4. 输出到目标位置
-**模板验证**:
-1. 检查必填章节是否存在
-2. 检查占位符是否全部填充
-3. 检查 Markdown 格式是否正确
-### 规范文档同步（standards）
-**规范加载**:
-1. 从 `knowledge/standards/` 读取规范文件
-2. 解析规范中的检查项
-3. 集成到 code-review 流程中
-**规范更新**:
-1. 定期 review 规范文档
-2. 根据实践反馈更新规范
-3. 更新后通知所有使用者
----
-## 校验规则
-### 章节完整性校验
-检查 MD 文件是否包含所有必填章节：
-```
-middleware:
-  - "## 基本信息"
-  - "## 环境变量"
-  - "## 连接代码模板"
-component:
-  - "## 基本信息"
-  - "## 接口定义"
-  - "## 使用示例"
-```
-### 表格格式校验
-- 表格必须有表头行
-- 表格列数必须一致
-- 必填表格不能为空
-### 类型枚举校验
-- 中间件类型必须在预定义枚举中
-- 组件类型必须在预定义枚举中
----
-## AI 生成参考
-### 环境知识生成
-| 场景 | 参考文件 |
-|------|---------|
-| 扫描检测 | `knowledge/guides/support/environment-scanner.md` |
-| 知识生成 | `knowledge/guides/support/knowledge-generator.md` |
-| 检测规则 | `knowledge/environment/detection-patterns.yaml` |
-### 研发文档生成
-| 场景 | 参考文件 |
-|------|---------|
-| 需求提案 | `knowledge/process/01-requirement.md` + `knowledge/templates/product-proposal.md` |
-| 系统设计 | `knowledge/process/02-design.md` + `knowledge/templates/system-design.md` |
-| 任务分解 | `knowledge/process/03-implementation.md` + `knowledge/templates/task-breakdown.md` |
-| 测试用例 | `knowledge/process/04-test.md` + `knowledge/templates/test-case.md` |
-| DDD设计 | `knowledge/guides/domain-driven-design.md` + `knowledge/templates/domain-driven-design.md` |
-### 规范文档引用
-| 场景 | 参考文件 |
-|------|---------|
-| 编码规范 | `knowledge/standards/coding-style.md` |
-| 数据一致性 | `knowledge/standards/data-consistency.md` |
-| Code Review | `knowledge/standards/code-review.md` |
----
-## 版本历史
-| 版本 | 日期 | 修改说明 |
-|-----|------|---------|
-| v1.0 | 2026-03-26 | 初始版本，定义 middleware 和 component 模板 |
-| v2.0 | 2026-03-26 | 新增 development/、api-docs/、standards/分类，注册所有研发模板和规范文档 |
-| v3.0 | 2026-03-26 | 新增 design-knowledge/、test-knowledge/、business-knowledge/ 分类，支持环境知识双向同步 |
-| v3.1 | 2026-03-26 | 新增 DDD 模板（domain-driven-design），模板命名规范化 |
----
-**维护者**: AutoSpec 团队
-**进化分区**: 🟡 受控区
-**关联文档**: `knowledge/environment/README.md`

package/knowledge/guides/domain-driven-design.md DELETED Viewed

@@ -1,345 +0,0 @@
-# 领域驱动设计方法论
-> **定位**: DDD方法论的实践指南，指导何时、如何应用DDD
->
-> **版本**: v1.0
-> **最后更新**: 2026-03-26
-> **权威来源**: Eric Evans《领域驱动设计》、Vaughn Vernon《实现领域驱动设计》
----
-## 何时使用DDD
-### 适用场景评估
-| 场景 | 推荐程度 | 原因 | 投入建议 |
-|------|---------|------|---------|
-| 核心业务系统 | ⭐⭐⭐ 强烈推荐 | 领域复杂度高，值得投入 | 重点建模 |
-| 支撑系统 | ⭐⭐ 可选 | 复杂度中等，按需使用 | 关键模块建模 |
-| CRUD系统 | ⭐ 不推荐 | 过度设计，简单方案即可 | 不需要DDD |
-| 快速原型 | ⭐ 不推荐 | 迭代太快，建模成本高 | 后期重构 |
-### 复杂度评估标准
-**推荐DDD的条件**（满足2个以上）：
-1. 业务概念数量 > 20个
-2. 业务规则复杂度 > 简单CRUD
-3. 需要跨团队协作
-4. 预期生命周期 > 2年
-5. 业务逻辑频繁变更
-**不推荐DDD的条件**：
-1. 简单CRUD操作为主
-2. 业务逻辑稳定不变
-3. 团队规模 < 3人
-4. 快速迭代原型阶段
----
-## DDD与AutoSpec流程融合
-### 需求阶段 → 战略设计
-| 需求阶段活动 | DDD对应活动 | 产出物 |
-|-------------|------------|--------|
-| 业务域拆解 | 子领域识别 | 核心域、支撑域、通用域划分 |
-| 用例分析 | 限界上下文边界识别 | 上下文定义、边界划分 |
-| 业务流程 | 上下文集成关系 | 上下文映射图 |
-| 术语提取 | 统一语言建立 | 术语表 |
-### 设计阶段 → 战术设计
-| 设计阶段活动 | DDD对应活动 | 产出物 |
-|-------------|------------|--------|
-| 系统设计 | 聚合设计、领域模型 | 聚合定义、实体、值对象 |
-| 接口设计 | 领域服务、仓储接口 | 服务定义、仓储契约 |
-| 数据库设计 | 聚合持久化映射 | 表结构、索引设计 |
-| 状态设计 | 聚合根状态机 | 状态流转图 |
-### 实现阶段
-| 实现阶段活动 | DDD实践 | 注意事项 |
-|-------------|---------|---------|
-| 代码组织 | 按聚合组织包结构 | 一个聚合一个包 |
-| 依赖管理 | 领域层不依赖基础设施 | 依赖倒置 |
-| 事件处理 | 领域事件驱动解耦 | 幂等处理 |
-| 持久化 | 仓储隔离持久化细节 | 聚合完整性 |
----
-## DDD核心实践
-### 统一语言（Ubiquitous Language）
-**定义**：团队共享的业务术语，消除沟通歧义
-**实践要点**：
-- 代码命名与业务术语一致
-- 文档与代码术语同步
-- 术语冲突必须消除
-- 新术语需要团队共识
-**常见问题**：
-| 问题 | 症状 | 解决方案 |
-|------|------|---------|
-| 术语不一致 | 同一概念多个名称 | 统一到术语表 |
-| 技术术语污染 | 代码用技术术语而非业务术语 | 重构命名 |
-| 术语漂移 | 不同阶段术语含义变化 | 定期审查术语表 |
-### 聚合设计原则
-**核心原则**：
-1. **小聚合优于大聚合**：减少并发冲突
-2. **通过ID引用其他聚合**：保持边界清晰
-3. **聚合边界 = 一致性边界**：事务边界
-**聚合大小判断**：
-```
-理想聚合大小：
-- 1个聚合根
-- 0-3个内部实体
-- 若干值对象
-- 不超过5个字段变更频繁的属性
-```
-**聚合划分信号**：
-| 信号 | 说明 | 行动 |
-|------|------|------|
-| 并发冲突频繁 | 多用户同时修改同一聚合 | 考虑拆分 |
-| 加载性能差 | 聚合数据量大 | 考虑拆分 |
-| 事务失败率高 | 事务涉及多个独立变更 | 考虑拆分 |
-| 部分字段很少使用 | 某些字段很少被访问 | 考虑拆分 |
-### 领域事件驱动
-**事件设计原则**：
-- 命名：过去时（OrderCreated, PaymentCompleted）
-- 不可变：事件一旦发生不可修改
-- 幂等：同一事件多次处理结果相同
-**事件驱动模式**：
-```
-聚合A变更 → 发布事件 → 事件总线 → 聚合B订阅 → 聚合B变更
-```
-**事件存储**：
-| 模式 | 说明 | 适用场景 |
-|------|------|---------|
-| 直接发布 | 事件直接发送到消息队列 | 允许丢失 |
-| 事件表 | 事件先存库再发送 | 不允许丢失 |
-| 事件溯源 | 事件作为状态存储 | 需要历史追溯 |
----
-## 上下文集成模式详解
-### 模式选择决策树
-```
-上下文关系类型？
-├── 同一团队
-│   └── Partnership（伙伴关系）
-├── 不同团队，下游有话语权
-│   └── Customer/Supplier（客户-供应商）
-├── 不同团队，下游无话语权
-│   ├── 需要隔离模型
-│   │   └── Anticorruption Layer（防腐层）
-│   └── 可以接受上游模型
-│       └── Conformist（跟随者）
-├── 共享核心逻辑
-│   └── Shared Kernel（共享内核）
-└── 对外提供服务
-    └── Open Host Service（开放主机服务）
-```
-### 模式详解
-#### Partnership（伙伴关系）
-**适用场景**：同一团队或紧密协作的团队
-**特点**：
-- 共同演进
-- 同步协调
-- 共享责任
-**实践建议**：
-- 定期同步会议
-- 共享代码仓库
-- 统一部署节奏
-#### Anticorruption Layer（防腐层）
-**适用场景**：集成外部系统或遗留系统
-**特点**：
-- 隔离外部模型
-- 适配器模式
-- 保护内部模型
-**实践建议**：
-- 定义清晰的适配接口
-- 外部模型不渗透到内部
-- 适配逻辑集中管理
----
-## 反模式警示
-### 贫血模型（Anemic Domain Model）
-**症状**：
-- 实体只有getter/setter
-- 业务逻辑全在服务层
-- 失去面向对象价值
-**风险**：
-- 业务逻辑散落
-- 难以维护
-- 重复代码
-**解决方案**：
-```
-// 错误：贫血模型
-class Order {
-    String status;
-    // 只有getter/setter
-}
-class OrderService {
-    void pay(Order order) {
-        order.setStatus("PAID");  // 业务逻辑在服务层
-    }
-}
-// 正确：富领域模型
-class Order {
-    String status;
-    void pay() {
-        if (!canPay()) throw new BusinessException();
-        this.status = "PAID";
-        publishEvent(new OrderPaidEvent(this.id));
-    }
-}
-```
-### 大聚合（Large Aggregate）
-**症状**：
-- 聚合包含过多实体
-- 加载性能差
-- 并发冲突频繁
-**风险**：
-- 性能问题
-- 可扩展性差
-- 用户体验差
-**解决方案**：
-```
-// 错误：大聚合
-class Order {
-    List<OrderItem> items;      // 可能有几十个
-    List<Payment> payments;     // 可能有多个
-    List<Refund> refunds;       // 可能有多个
-    List<Logistics> logistics;  // 可能有多个
-}
-// 正确：拆分小聚合
-class Order {
-    String id;
-    String status;
-    Money totalAmount;
-    // 只保留核心属性
-}
-class OrderItem { /* 独立聚合 */ }
-class Payment { /* 独立聚合 */ }
-class Refund { /* 独立聚合 */ }
-```
-### 领域服务滥用
-**症状**：
-- 服务承载所有逻辑
-- 实体变成数据容器
-- 过程式代码
-**风险**：
-- 失去DDD价值
-- 代码难以理解
-- 测试困难
-**解决方案**：
-```
-// 错误：逻辑在服务
-class OrderService {
-    void calculateTotal(Order order) {
-        // 计算逻辑在服务
-    }
-}
-// 正确：逻辑在实体
-class Order {
-    Money calculateTotal() {
-        return items.stream()
-            .map(Item::getPrice)
-            .reduce(Money.ZERO, Money::add);
-    }
-}
-```
----
-## DDD实施检查清单
-### 战略设计阶段
-- [ ] 识别核心域、支撑域、通用域
-- [ ] 定义限界上下文边界
-- [ ] 绘制上下文映射图
-- [ ] 确定上下文集成模式
-- [ ] 建立统一语言术语表
-### 战术设计阶段
-- [ ] 设计聚合边界
-- [ ] 定义聚合根、实体、值对象
-- [ ] 设计领域服务
-- [ ] 定义领域事件
-- [ ] 设计仓储接口
-### 实现阶段
-- [ ] 代码结构按聚合组织
-- [ ] 领域层不依赖基础设施
-- [ ] 领域事件驱动解耦
-- [ ] 仓储隔离持久化细节
-- [ ] 统一语言一致性检查
----
-## 参考资料
-### 权威书籍
-1. **Eric Evans《Domain-Driven Design: Tackling Complexity in the Heart of Software》**
-   - DDD奠基之作
-   - 战略设计核心概念
-2. **Vaughn Vernon《Implementing Domain-Driven Design》**
-   - 实践指南
-   - 战术设计详解
-### 在线资源
-- Microsoft Azure Architecture Center - Tactical DDD
-- DDD Crew GitHub - Bounded Context Canvas, Context Mapping
-- Martin Fowler - CQRS, Event Sourcing
----
-**维护者**: AutoSpec 团队
-**进化分区**: 🟡 受控区
-**关联文档**: `knowledge/templates/domain-driven-design.md`