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/plugins/commands/env-sync.md DELETED Viewed

@@ -1,640 +0,0 @@
----
-description: 初始化环境目录并同步环境知识，AI 提炼最佳实践和配置模板
----
-# AutoSpec Env Sync — 环境知识同步
-## 用户输入
-```
-$ARGUMENTS
-```
----
-## 执行指令
-### Step 0: 初始化环境目录（如不存在）
-检查 `.autospec/environment/` 是否已存在：
-- 不存在 → 自动创建目录结构
-- 已存在 → 跳过初始化，直接进入扫描
-创建目录结构：
-```
-.autospec/environment/
-├── env-knowledge/
-│   ├── middleware/         # 中间件知识（MD格式）
-│   ├── infrastructure/     # 基础设施知识
-│   └── env-variables/      # 环境变量模板
-├── component-lib/
-│   ├── components/         # 组织组件库（MD格式）
-│   ├── best-practices/     # 最佳实践
-│   └── domain-models/      # 领域模型
-├── design-knowledge/       # 设计知识库
-│   ├── product/            # 产品设计
-│   ├── architecture/       # 架构设计（含UML图）
-│   ├── api/                # 接口设计
-│   └── database/           # 数据库设计
-├── test-knowledge/         # 测试知识库
-│   ├── test-designs/       # 测试设计
-│   └── evaluation/         # 评测设计（AI/模型）
-├── business-knowledge/     # 业务知识库
-│   ├── glossary.md         # 术语表
-│   ├── rules.md            # 业务规则
-│   └── flows/              # 业务流程图
-├── standards/              # 规范知识库
-│   ├── coding-style.md
-│   ├── data-consistency.md
-│   └── code-review.md
-├── guides/                 # 指南知识库
-│   ├── system-design.md
-│   ├── requirement-engineering.md
-│   └── stages/             # 各阶段指南
-├── integration/
-│   ├── ci-cd/              # CI/CD配置
-│   ├── testing/            # 测试环境
-│   └── deployment/         # 部署配置
-├── knowledge-source.json   # 知识来源配置
-└── registry.json           # 知识注册表
-```
-初始化 `registry.json`（如不存在）：
-```json
-{
-  "version": "2.0",
-  "activeProfiles": {
-    "environment": "development",
-    "components": []
-  },
-  "environmentKnowledge": {
-    "middleware": [],
-    "infrastructure": [],
-    "envVariables": []
-  },
-  "componentKnowledge": {
-    "components": [],
-    "bestPractices": [],
-    "domainModels": []
-  },
-  "designKnowledge": {
-    "product": [],
-    "architecture": [],
-    "api": [],
-    "database": []
-  },
-  "testKnowledge": {
-    "testDesigns": [],
-    "evaluation": []
-  },
-  "businessKnowledge": {
-    "glossary": [],
-    "rules": [],
-    "flows": []
-  },
-  "standardsKnowledge": [],
-  "guidesKnowledge": [],
-  "integrationKnowledge": {
-    "ci_cd": [],
-    "testing": [],
-    "deployment": []
-  }
-}
-```
-### Step 0.5: 加载模板定义
-**【强制】** 读取模板注册表和模板文件：
-1. **读取模板注册表**
-   - 优先读取框架模板：`knowledge/environment/template-registry.md`
-   - 项目级自定义模板（如有）：`.autospec/knowledge/environment/template-registry.md`
-2. **加载模板文件**
-   - 中间件模板：`knowledge/environment/middleware-knowledge.md`
-   - 组件模板：`knowledge/environment/component-knowledge.md`
-   - 设计/测试/业务模板：`knowledge/templates/*.md`
-3. **缓存模板信息**
-   - 必填章节列表
-   - 类型枚举
-   - 输出路径模板
-### Step 1: 扫描代码（确定性）
-**【强制】** 根据 `knowledge/environment/detection-patterns.yaml` 中的检测规则执行扫描：
-1. **扫描依赖文件**（使用 buildFiles 规则）
-   - package.json / requirements.txt / pom.xml / go.mod 等
-   - 提取依赖列表并匹配框架识别规则
-2. **扫描代码模式**（使用 sourceDirectories 规则）
-   - 定位源码目录（backend/frontend/data/ai）
-   - 匹配 import/require/实例化模式
-3. **扫描环境变量**
-   - process.env.XXX
-   - os.environ.get('XXX')
-   - System.getenv("XXX")
-4. **检测 AI/数据组件**（使用 aiComponents 和 dataComponents 规则）
-   - 识别 LLM 应用、RAG、向量存储
-   - 识别数据仓库、ETL 管道
-输出扫描结果到 `.autospec/runtime/env-scan-result.json`
-### Step 1: 判断同步模式
-根据用户输入判断同步模式：
-**本地扫描模式**（无参数）：
-- 扫描项目代码生成知识
-- 继续执行 Step 2-7
-**导入模式**（有参数或 URL）：
-1. **解析输入**
-   - `<url>` - 自动识别类型
-   - `--git <url>` - 明确 Git 仓库
-   - `--online <url>` - 明确在线文档
-   - `--npm <package>` - npm 包
-   - `--local <path>` - 本地目录
-2. **URL 自动识别规则**
-   | URL 模式 | 类型 | 处理方式 |
-   |---------|------|---------|
-   | `https://github.com/...` | Git | git clone |
-   | `git@github.com:...` | Git | git clone |
-   | Confluence/在线文档平台 等 | 在线文档 | 对应 API |
-   | 其他 | Git | 尝试 git clone |
-跳转到 Step 1a 执行导入流程。
-### Step 1a: 执行导入（导入模式）
-根据来源类型执行导入：
-**Git 来源**：
-```bash
-git clone --depth 1 {url} /tmp/autospec-import
-```
-**在线文档来源**：
-- 识别文档平台（Confluence、在线文档平台 等）
-- 使用对应 API 读取文档内容
-- 转换为本地知识文件格式
-**npm 来源**：
-```bash
-npm pack {package}
-tar -xzf {package}-*.tgz
-```
-**本地来源**：
-```bash
-cp -r {path}/* .autospec/environment/
-```
-### Step 1b: 验证知识库结构（导入模式）
-检查导入的知识库是否包含：
-- `manifest.json` 或 `package.json`
-- `env-knowledge/` 目录
-- `component-lib/` 目录
-### Step 1c: 模板合规检查（导入模式）
-加载模板注册表 `knowledge/environment/template-registry.md`，对每个知识文件：
-**中间件文件** (`env-knowledge/middleware/*.md`)：
-- 校验是否包含必填章节：基本信息、环境变量、连接代码模板
-- 检查基本信息表格是否包含：名称、类型
-- 检查类型是否在预定义枚举中
-**组件文件** (`component-lib/components/*/component.md`)：
-- 校验是否包含必填章节：基本信息、接口定义、使用示例
-- 检查基本信息表格是否包含：名称、类型、版本
-- 检查类型是否在预定义枚举中
-**设计/测试/业务知识文件**：
-- 校验是否包含对应模板的必填章节
-生成校验报告：
-```
-🔍 模板合规检查
-中间件: 5 文件
-  ✅ mysql.md - 符合模板规范
-  ✅ redis.md - 符合模板规范
-  ⚠️  kafka.md - 缺少「连接代码模板」章节
-  ❌ es.md - 缺少必填章节「基本信息」
-组件: 2 文件
-  ✅ auth/component.md - 符合模板规范
-  ❌ payment/component.md - 缺少必填章节「接口定义」
-总计: 7 文件, 4 完全合规, 1 有警告, 2 不合规
-```
-### Step 1d: AI 补全缺失章节（导入模式）
-对校验通过但缺少可选章节的知识文件：
-1. **分析项目上下文**
-   - 当前项目技术栈
-   - 已有的环境配置
-   - 检测到的依赖包
-2. **AI 补全缺失章节**
-   - 根据模板规范补全缺失的可选章节
-   - 例如：连接代码模板、最佳实践、反模式清单
-3. **提供补全预览**
-   ```
-   📝 将补全以下章节：
-   kafka.md:
-     + 连接代码模板（Node.js、Python）
-     + 最佳实践
-     + 健康检查
-   是否执行补全？[Y/n]
-   ```
-4. **执行补全**
-   用户确认后，AI 补全并保存文件
-### Step 1e: 分析相关性（导入模式）
-1. **识别内容**
-   - 包含的中间件列表
-   - 包含的组件列表
-   - 包含的最佳实践
-2. **分析相关性**
-   - 与当前项目技术栈的匹配度
-   - 推荐激活的知识项
-3. **提供激活建议**
-   ```
-   相关性分析:
-     技术栈匹配度: 85%
-     推荐激活: mysql, redis, auth
-   ```
-跳转到 Step 8 继续执行。
----
-## 本地扫描模式流程
-### Step 2: 扫描设计文档
-**【强制】** 扫描项目中的设计文档：
-1. **扫描产品设计文档**
-   - 扫描 `specs/` 目录下的 `proposal.md`
-   - 扫描 `docs/product/` 目录
-   - 提取业务架构设计、用例业务流程
-2. **扫描架构设计文档**
-   - 扫描 `specs/` 目录下的 `design.md`
-   - 扫描 `docs/architecture/` 目录
-   - 提取 UML 图（用例图、时序图、类图、框图、状态图等）
-3. **扫描接口设计文档**
-   - 扫描 `docs/api/` 目录
-   - 扫描 `openapi.yaml` / `swagger.json`
-   - 提取接口概述、参数定义、错误码
-4. **扫描数据库设计文档**
-   - 扫描 `docs/database/` 目录
-   - 扫描 `*.sql` 文件中的表结构
-   - 提取 ER 图、表结构、索引设计
-### Step 3: 扫描测试文档
-**【强制】** 扫描项目中的测试相关文档：
-1. **扫描测试设计文档**
-   - 扫描 `specs/` 目录下的 `testcase.md`
-   - 扫描 `tests/` 目录下的测试设计
-   - 提取测试概要、测试用例、覆盖矩阵
-2. **扫描AI评测文档**
-   - 扫描 `evaluation/` 目录
-   - 扫描 `benchmarks/` 目录
-   - 提取评测目标、数据集、指标定义
-### Step 4: 扫描规范指南
-**【强制】** 扫描项目中的规范和指南文档：
-1. **扫描规范文档**
-   - 扫描 `docs/standards/` 目录
-   - 扫描 `.editorconfig` / `.eslintrc` / `checkstyle.xml`
-   - 提取编码规范、数据一致性规范
-2. **扫描指南文档**
-   - 扫描 `docs/guides/` 目录
-   - 扫描 `knowledge/guides/` 目录
-   - 提取系统设计指南、需求工程指南
-### Step 5: 扫描业务知识
-**【强制】** 扫描项目中的业务知识文档：
-1. **扫描术语表**
-   - 扫描 `docs/business/glossary.md`
-   - 扫描 `knowledge/domain/glossary.md`
-   - 提取术语定义
-2. **扫描业务规则**
-   - 扫描 `docs/business/rules.md`
-   - 扫描 `knowledge/domain/rules.md`
-   - 提取规则ID、规则描述
-3. **扫描业务流程**
-   - 扫描 `docs/business/flows/` 目录
-   - 扫描 `knowledge/domain/flows/` 目录
-   - 提取 Mermaid 流程图
-### Step 6: 分析每个检测项（AI）
-对每个检测到的中间件/组件：
-1. **阅读相关代码文件**
-   - 找到使用该中间件的代码文件
-   - 理解使用上下文
-2. **提取配置模式**
-   - 连接配置方式
-   - 初始化参数
-   - 错误处理模式
-3. **识别使用特征**
-   - 连接池配置
-   - 重试机制
-   - 超时设置
-   - 认证方式
-### Step 7: 生成知识文件（AI）
-**【强制】** 按模板规范生成 Markdown 格式的知识文件：
-加载模板：
-- 中间件模板：`knowledge/environment/middleware-knowledge.md`
-- 组件模板：`knowledge/environment/component-knowledge.md`
-**中间件知识格式**：
-```markdown
-# {名称} 中间件知识
-## 基本信息
-| 字段 | 值 |
-|------|-----|
-| 名称 | {name} |
-| 类型 | {type} |
-| 默认端口 | {port} |
-| 知识版本 | v1.0 |
-## 环境变量
-### 必需变量
-| 变量名 | 说明 | 示例 |
-|--------|------|------|
-| {NAME}_HOST | 主机地址 | db.example.com |
-| {NAME}_PASSWORD | 密码 | - |
-### 可选变量
-| 变量名 | 默认值 | 说明 |
-|--------|--------|------|
-| {NAME}_PORT | {默认端口} | 端口号 |
-## 连接代码模板
-### Node.js
-```javascript
-// 连接代码
-```
-### Python
-```python
-# 连接代码
-```
-## 最佳实践
-1. 实践1
-2. 实践2
-## 反模式清单
-| 反模式 | 风险 | 替代方案 |
-|--------|------|----------|
-| 反模式描述 | 风险说明 | 替代方案 |
-## 健康检查
-```bash
-# 健康检查命令
-```
-```
-**组件知识格式**：
-```markdown
-# {名称} 组件知识
-## 基本信息
-| 字段 | 值 |
-|------|-----|
-| 名称 | {name} |
-| 类型 | {type} |
-| 版本 | {version} |
-## 功能描述
-组件功能描述
-## 接口定义
-| 方法名 | 说明 |
-|--------|------|
-| method1 | 方法说明 |
-## 使用示例
-### Node.js
-**安装**
-```bash
-npm install @org/component
-```
-**使用**
-```javascript
-// 使用代码
-```
-## 配置项
-### 必需配置
-| 配置项 | 说明 |
-|--------|------|
-| CONFIG_ENDPOINT | 服务地址 |
-## 使用检查清单
-### 使用前检查
-- [ ] 检查项1
-- [ ] 检查项2
-```
-### Step 8: 模板合规校验
-**【强制】** 对生成的每个知识文件，执行模板校验：
-1. **章节完整性检查**
-   - 中间件：基本信息、环境变量、连接代码模板
-   - 组件：基本信息、接口定义、使用示例
-2. **表格格式校验**
-   - 表格必须有表头行
-   - 表格列数必须一致
-   - 必填表格不能为空
-3. **类型枚举校验**
-   - 中间件类型必须在预定义枚举中
-   - 组件类型必须在预定义枚举中
-校验通过后进入 Step 9 注册。
-### Step 9: 注册激活
-1. 将知识文件写入对应目录：
-   - 中间件：`.autospec/environment/env-knowledge/middleware/{name}.md`
-   - 组件：`.autospec/environment/component-lib/components/{name}/component.md`
-2. 更新 `registry.json`
-3. 标记为自动检测
----
-## 产出物
-- `.autospec/environment/` 目录结构（如不存在则创建）
-- `.autospec/runtime/env-scan-result.json` 扫描结果
-- `.autospec/environment/env-knowledge/middleware/*.md` 中间件知识（Markdown格式）
-- `.autospec/environment/component-lib/components/*/component.md` 组件知识（Markdown格式）
-- `.autospec/environment/design-knowledge/` 设计知识（Markdown格式）
-- `.autospec/environment/test-knowledge/` 测试知识（Markdown格式）
-- `.autospec/environment/business-knowledge/` 业务知识（Markdown格式）
-- `.autospec/environment/standards/` 规范文档（Markdown格式）
-- `.autospec/environment/guides/` 指南文档（Markdown格式）
-- 更新的 `registry.json`
-- `knowledge-source.json` 知识来源配置（如需要）
----
-## 输出结果
-### 本地扫描模式
-```
-✅ 环境知识同步完成
-初始化:
-  .autospec/environment/     目录结构
-模板加载:
-  template-registry.md
-  middleware-knowledge.md
-  component-knowledge.md
-  api-design.md
-  database-design.md
-  ai-evaluation.md
-扫描结果:
-  依赖: X 项
-  中间件: X 项
-  环境变量: X 项
-  设计文档: X 项
-  测试文档: X 项
-  规范文档: X 项
-  业务知识: X 项
-生成知识:
-  环境知识:
-    middleware/mysql.md
-    middleware/redis.md
-    components/auth/component.md
-  设计知识:
-    design-knowledge/product/order-system.md
-    design-knowledge/architecture/order-service.md
-    design-knowledge/api/order-api.md
-    design-knowledge/database/order-db.md
-  测试知识:
-    test-knowledge/test-designs/order-test.md
-    test-knowledge/evaluation/chat-bot-eval.md
-  业务知识:
-    business-knowledge/glossary.md
-    business-knowledge/rules.md
-    business-knowledge/flows/order-flow.md
-  规范指南:
-    standards/coding-style.md
-    guides/system-design.md
-校验结果:
-  ✅ mysql.md - 符合模板规范
-  ✅ redis.md - 符合模板规范
-  ✅ auth/component.md - 符合模板规范
-下一步:
-  1. 检查生成的知识文件
-  2. 执行 /autospec:env-validate 验证配置
-  3. 执行 /autospec:env-update --dry-run 预览变更
-  4. 手动调整配置细节
-```
-### 导入模式
-```
-✅ 知识库导入完成
-来源: https://github.com/org/design-templates
-类型: Git
-结构验证:
-  ✅ manifest.json 存在
-  ✅ env-knowledge/ 目录存在
-  ✅ component-lib/ 目录存在
-模板合规检查:
-  中间件: 5 文件, 4 合规
-  组件: 2 文件, 1 合规
-自动补全:
-  kafka.md - 已补全「连接代码模板」「最佳实践」
-相关性分析:
-  技术栈匹配度: 85%
-  推荐激活: mysql, redis, auth
-下一步:
-  1. 检查导入的知识文件
-  2. 执行 /autospec:env-validate 验证配置
-  3. 执行 /autospec:env 查看环境状态
-```