zdashboard 2.0.0 → 2.1.1

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
@@ -13,6 +13,7 @@ zdashboard/ ← 一个核心包,永远不写业务逻辑
13
13
  │ │ ├── tree.ts ← /__files 文件树
14
14
  │ │ └── manifest.ts ← /__plugins 插件清单
15
15
  │ ├── plugins/ ← 内置 plugins(随核心发版)
16
+ │ │ ├── stats/ ← 项目统计(文件/目录/大小/扩展名 Top10)
16
17
  │ │ ├── just/ ← Just Runner 任务执行
17
18
  │ │ ├── bugs/ ← 禅道 Bugs 只读列表
18
19
  │ │ ├── review/ ← 文档评审状态流转
@@ -63,6 +64,21 @@ export default {
63
64
  } as const;
64
65
  ```
65
66
 
67
+ 可选 `Sidebar` 槽(如 view、design 提供侧栏):
68
+
69
+ ```ts
70
+ import Sidebar from './Sidebar.js';
71
+
72
+ export default {
73
+ mode: '<mode>',
74
+ label: '显示名',
75
+ icon: '🎯',
76
+ description: '简短描述',
77
+ Sidebar: lazy(() => import('./Sidebar.js')),
78
+ Workspace: lazy(() => import('./Workspace.js')),
79
+ } as const;
80
+ ```
81
+
66
82
  ```ts
67
83
  // src/plugins/<mode>/index.ts
68
84
  export default {
@@ -186,7 +202,6 @@ node dist/cli.js --dir <项目根> --port 4190 --plugins ./my-plugins
186
202
 
187
203
  ### 环境变量
188
204
 
189
- - `PORT`:默认 4190(未被 `--port` 覆盖时)
190
205
 
191
206
  ### 内置路由
192
207
 
@@ -208,7 +223,11 @@ node dist/cli.js --dir <项目根> --port 4190 --plugins ./my-plugins
208
223
  | `/__docs` | GET | 项目文档列表 |
209
224
  | `/__apply` | GET | OpenSpec changes 列表 |
210
225
  | `/__apply/change` | GET | `?name=<change>` 详情 |
226
+ | `/__worktrees` | GET | `.zworktree/` 下的 worktree 列表(`git worktree list --porcelain`) |
211
227
  | `/__design/assets` | GET | 设计资产扫描 |
228
+ | `/__stats/data` | GET | 项目统计(内置 stats 插件) |
229
+ | `/__notes/data` | GET | 便签列表(examples/notes 示例) |
230
+ | `/__notes/save` | POST | 保存便签(`x-stop-token` 鉴权) |
212
231
 
213
232
  ## 前端路由
214
233
 
@@ -229,6 +248,28 @@ node dist/cli.js --dir <项目根> --port 4190 --plugins ./my-plugins
229
248
  - **构建**:tsup(CLI) + Vite(SPA)
230
249
  - **包管理**:pnpm
231
250
 
251
+ ## 数据约定
252
+
253
+ ### .zdev/ 数据目录
254
+
255
+ zdashboard v2.1+ 优先读取 `.zdev/` 下的数据文件(与 zskills 新协议对齐):
256
+
257
+ | 文件 | 说明 | 回退路径 |
258
+ |------|------|---------|
259
+ | `.zdev/config.yaml` | 禅道凭据(zgoal skill 创建) | `.zgoal/config.yaml` |
260
+ | `.zdev/review.yaml` | 评审数据 | 根目录 `review.yaml` |
261
+ | `.zdev/*.md` | 评审相关文档(brief.md 等) | — |
262
+
263
+ 启动日志会打印数据目录:`data -> .zdev/`(仅 `.zdev/` 存在时)。
264
+
265
+ ### worktree 执行模型
266
+
267
+ zapply 在 `.zworktree/<change-name>/` 下创建独立 worktree,apply 插件会优先读取 worktree 内的 `tasks.md`/`proposal.md`/`design.md`,主目录兜底。Viewer 卡片会显示 `worktree 执行中` badge。
268
+
269
+ ### --restart 端口继承
270
+
271
+ `--restart` 重启时,新实例会优先尝试旧实例的端口(通过 `.zdev/dashboard.json` 记录),避免书签/标签失效。用户显式 `--port` 时仍尊重用户选择。
272
+
232
273
  ## 迁移状态
233
274
 
234
275
  - [x] zview-dashboard → zdashboard(v1.0.0)