jarvis-agent-factory 3.47.3 → 3.47.4
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.
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Jarvis Agent Factory · 贾维斯智能体工厂
|
|
2
2
|
|
|
3
3
|
[](./LICENSE)
|
|
4
|
-
[](https://github.com/Wjl1224734792/Jarvis-Agent-Factory/releases)
|
|
5
5
|
[](https://www.npmjs.com/package/jarvis-agent-factory)
|
|
6
6
|
[](https://github.com/Wjl1224734792/visual-primitives-mcp)
|
|
7
7
|
<br>💡 **纯文本模型（如 DeepSeek）主力用户** → 搭配 [Visual Primitives MCP](https://github.com/Wjl1224734792/visual-primitives-mcp) 获得视觉理解能力
|
package/dist/package.json
CHANGED
|
@@ -1,131 +1,133 @@
|
|
|
1
1
|
---
|
|
2
|
-
description:
|
|
3
|
-
argument-hint: [--dry-run 预览模式] [--
|
|
4
|
-
version: "3.47.
|
|
2
|
+
description: 同步项目文档——检查并更新核心文档使其与代码一致，清理过时文件
|
|
3
|
+
argument-hint: [--dry-run 预览模式] [--no-clean 跳过清理]
|
|
4
|
+
version: "3.47.3"
|
|
5
5
|
updated: "2026-05-14"
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
#
|
|
8
|
+
# 同步项目文档
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
检查项目核心文档是否与代码现状一致，修复不一致处，清理过时文件。
|
|
11
11
|
|
|
12
|
-
## 步骤 0
|
|
12
|
+
## 步骤 0：扫描项目现状
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
首先了解项目当前实际情况（用于后续对比文档）：
|
|
15
15
|
|
|
16
|
-
1.
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
16
|
+
1. **技术栈**：读取 `package.json`（scripts、dependencies）、`tsconfig.json`、框架配置文件
|
|
17
|
+
2. **项目结构**：列出主要源码目录（`src/`、`web/`、`app/` 等）和关键配置文件
|
|
18
|
+
3. **命令清单**：扫描 `.claude/commands/` 下所有 `.md` 文件，提取命令名和描述
|
|
19
|
+
4. **Git 信息**：获取当前分支、最近提交、远程地址
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
执行 `npm root -g` 获取全局 node_modules 路径，拼接 `/jarvis-agent-factory/dist/src/templates/platforms/claude/`
|
|
21
|
+
---
|
|
23
22
|
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
未找到 jarvis-agent-factory 模板源。
|
|
23
|
+
## 步骤 1：检查 CLAUDE.md
|
|
27
24
|
|
|
28
|
-
|
|
29
|
-
npm install jarvis-agent-factory
|
|
25
|
+
**CLAUDE.md** 是项目的 AI 指令文件。对比以下方面：
|
|
30
26
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
27
|
+
| 检查项 | 方法 |
|
|
28
|
+
|--------|------|
|
|
29
|
+
| 项目名称和简介 | 与 `package.json` 的 name/description 对比 |
|
|
30
|
+
| 常用命令 | 与 `package.json` scripts 对比 |
|
|
31
|
+
| 目录结构 | 与实际源码目录对比 |
|
|
32
|
+
| 技术栈 | 与 dependencies/devDependencies 对比 |
|
|
33
|
+
| 架构说明 | 与实际模块结构对比 |
|
|
35
34
|
|
|
36
|
-
|
|
35
|
+
**不一致时**：报告具体差异，修复 CLAUDE.md 中过时的内容。
|
|
37
36
|
|
|
38
|
-
|
|
37
|
+
**CLAUDE.md 不存在时**：基于项目现状自动生成初始版本。
|
|
39
38
|
|
|
40
|
-
|
|
39
|
+
---
|
|
41
40
|
|
|
42
|
-
|
|
41
|
+
## 步骤 2：检查 AGENTS.md
|
|
43
42
|
|
|
44
|
-
|
|
45
|
-
- 对每个模板文件：
|
|
46
|
-
- 读取模板文件内容
|
|
47
|
-
- 检查目标 `.claude/commands/<文件名>` 是否存在
|
|
48
|
-
- **目标不存在** → 创建文件，写入模板内容
|
|
49
|
-
- **目标存在、内容相同** → 无需操作
|
|
50
|
-
- **目标存在、内容不同** → 默认跳过（视为用户已自定义）
|
|
51
|
-
- `--force` 模式：内容不同时以模板覆盖目标
|
|
43
|
+
**AGENTS.md** 是 agent 协作约定。对比：
|
|
52
44
|
|
|
53
|
-
|
|
45
|
+
| 检查项 | 方法 |
|
|
46
|
+
|--------|------|
|
|
47
|
+
| Agent 列表 | 与 `.claude/agents/` 目录对比 |
|
|
48
|
+
| 命令引用 | 与 `.claude/commands/` 目录对比 |
|
|
49
|
+
| 约束/规范 | 与 `CLAUDE.md` 中的约束一致 |
|
|
54
50
|
|
|
55
|
-
|
|
51
|
+
---
|
|
56
52
|
|
|
57
|
-
|
|
58
|
-
- 对每个技能目录，逐文件比对：
|
|
59
|
-
- **目标不存在** → 递归创建整个技能目录
|
|
60
|
-
- **目标存在** → 逐文件比对：
|
|
61
|
-
- 模板有、目标无 → 新增文件
|
|
62
|
-
- 模板有、目标有、内容相同 → 跳过
|
|
63
|
-
- 模板有、目标有、内容不同 → 默认跳过（用户已自定义）
|
|
64
|
-
- 目标有、模板无 → 跳过（用户自行添加的文件，不删除）
|
|
53
|
+
## 步骤 3：检查 README.md
|
|
65
54
|
|
|
66
|
-
|
|
55
|
+
| 检查项 | 方法 |
|
|
56
|
+
|--------|------|
|
|
57
|
+
| 安装命令 | 从 `package.json` 推断正确的安装方式 |
|
|
58
|
+
| 使用说明 | 与 CLI 入口文件对比 |
|
|
59
|
+
| 版本徽章 | 与当前版本号一致 |
|
|
67
60
|
|
|
68
|
-
|
|
61
|
+
**README.md 是面向人类用户的门面文档**，修复时只修正**事实性错误**（错误命令、过时版本），不改变写作风格和叙述结构。
|
|
69
62
|
|
|
70
|
-
|
|
71
|
-
- 比较策略与步骤 1 相同
|
|
72
|
-
- 若模板中无 `agents/` 目录 → 跳过此步骤
|
|
63
|
+
---
|
|
73
64
|
|
|
74
|
-
##
|
|
65
|
+
## 步骤 4：检查 CHANGELOG.md
|
|
75
66
|
|
|
76
|
-
|
|
67
|
+
| 检查项 | 方法 |
|
|
68
|
+
|--------|------|
|
|
69
|
+
| 版本条目 | 当前版本号应有对应条目 |
|
|
70
|
+
| 近期变更 | 与 `git log` 对比，确保最近变更已记录 |
|
|
77
71
|
|
|
78
|
-
|
|
79
|
-
- 目标目录中存在但模板中不存在的文件/目录 → 视为用户自行添加，**不删除**
|
|
80
|
-
- 以下路径始终跳过：
|
|
81
|
-
- `node_modules/`、`.git/`
|
|
82
|
-
- `dist/`、`build/`、`.next/`（构建产物）
|
|
83
|
-
- `docs/` 下含日期路径的子目录（`YYYY-MM-DD/`）
|
|
84
|
-
- `*.log`、`.cache`、`.tmp`（临时文件）
|
|
72
|
+
**CHANGELOG.md 不存在时**：不自动创建（CHANGELOG 应由开发者手动维护）。
|
|
85
73
|
|
|
86
|
-
|
|
74
|
+
---
|
|
87
75
|
|
|
88
|
-
|
|
89
|
-
- **--dry-run 模式**：预览全部变更（新增/覆盖/跳过），不实际修改任何文件
|
|
90
|
-
- **--force 模式**：模板与目标内容不同时，以模板为准覆盖目标文件
|
|
91
|
-
- **保守删除**：不自动删除目标目录中的任何文件或目录
|
|
76
|
+
## 步骤 5：清理过时文件
|
|
92
77
|
|
|
93
|
-
|
|
78
|
+
扫描项目根目录和 `.claude/` 目录，标记并清理过时文件：
|
|
94
79
|
|
|
95
|
-
|
|
80
|
+
**可清理的类型**：
|
|
81
|
+
- `.claude/` 下不在模板中的孤立 `.md` 文件（用户确认后删除）
|
|
82
|
+
- 空目录
|
|
83
|
+
- IDE/编辑器临时文件（`.DS_Store`、`Thumbs.db`）
|
|
84
|
+
- 日志文件（`*.log`）超过 30 天
|
|
85
|
+
|
|
86
|
+
**绝不可触碰**：
|
|
87
|
+
- `dist/`、`build/`、`.next/` — 构建产物
|
|
88
|
+
- `node_modules/`、`.git/` — 依赖和版本控制
|
|
89
|
+
- `docs/YYYY-MM-DD/` — 日期驱动的流水线产物
|
|
90
|
+
- 任何 `.env` 文件
|
|
91
|
+
- 用户明确标记为 keep 的文件
|
|
92
|
+
|
|
93
|
+
**清理策略**：列出待清理清单 → 用户确认 → 执行。`--dry-run` 只列出不执行。
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 步骤 6：同步报告
|
|
96
98
|
|
|
97
99
|
```
|
|
98
|
-
===
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
（若模板中无 agents 目录则显示"模板中无 agents 目录，已跳过"）
|
|
120
|
-
|
|
121
|
-
总计: 新增 N / 更新 N / 跳过 N / 一致 N
|
|
122
|
-
预览模式: 是 / 否
|
|
100
|
+
=== 文档同步报告 ===
|
|
101
|
+
|
|
102
|
+
【CLAUDE.md】
|
|
103
|
+
✓ 一致 / ~ 已修复 N 处不一致 / + 已创建
|
|
104
|
+
修复项: （列出具体修改）
|
|
105
|
+
|
|
106
|
+
【AGENTS.md】
|
|
107
|
+
✓ 一致 / ~ 已修复 N 处不一致
|
|
108
|
+
修复项: （列出具体修改）
|
|
109
|
+
|
|
110
|
+
【README.md】
|
|
111
|
+
✓ 一致 / ~ 已修复 N 处事实性错误
|
|
112
|
+
修复项: （列出具体修改）
|
|
113
|
+
|
|
114
|
+
【CHANGELOG.md】
|
|
115
|
+
✓ 已记录最新版本 / ⚠ 缺少 vX.Y.Z 条目
|
|
116
|
+
|
|
117
|
+
【清理】
|
|
118
|
+
待清理: N 个文件/目录
|
|
119
|
+
已清理: N 个
|
|
120
|
+
预览模式: 是 / 否
|
|
123
121
|
```
|
|
124
122
|
|
|
123
|
+
---
|
|
124
|
+
|
|
125
125
|
## 运行约束
|
|
126
126
|
|
|
127
127
|
- 所有文件操作使用绝对路径
|
|
128
|
-
-
|
|
129
|
-
- `--dry-run`
|
|
130
|
-
-
|
|
131
|
-
-
|
|
128
|
+
- **文档对比必须实际读取文件内容**，不可凭记忆判断
|
|
129
|
+
- `--dry-run` 模式不执行任何写入或删除
|
|
130
|
+
- `--no-clean` 模式跳过清理步骤
|
|
131
|
+
- 对 README.md 只修正事实性错误，不改变写作风格
|
|
132
|
+
- 清理步骤需用户确认后才执行实际删除
|
|
133
|
+
- 路径使用 `/`（Unix 风格，跨平台）
|
package/package.json
CHANGED