@newpeak/barista-cli 0.1.0

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 (82) hide show
  1. package/.eslintrc.json +23 -0
  2. package/.prettierrc +9 -0
  3. package/.sisyphus/notepads/liberica-employees/learnings.md +73 -0
  4. package/AGENTS.md +270 -0
  5. package/CONTRIBUTING.md +291 -0
  6. package/README.md +707 -0
  7. package/bin/barista +6 -0
  8. package/bin/barista.js +3 -0
  9. package/docs/ARCHITECTURE.md +184 -0
  10. package/docs/COMMANDS.md +352 -0
  11. package/docs/COMMAND_DESIGN_SPEC.md +811 -0
  12. package/docs/INTEGRATION_NOTES.md +270 -0
  13. package/docs/commands/REFERENCE.md +297 -0
  14. package/docs/commands/arabica/auth/index.md +296 -0
  15. package/docs/commands/liberica/auth/index.md +133 -0
  16. package/docs/commands/liberica/context/index.md +60 -0
  17. package/docs/commands/liberica/employees/create.md +185 -0
  18. package/docs/commands/liberica/employees/disable.md +138 -0
  19. package/docs/commands/liberica/employees/enable.md +137 -0
  20. package/docs/commands/liberica/employees/get.md +153 -0
  21. package/docs/commands/liberica/employees/list.md +168 -0
  22. package/docs/commands/liberica/employees/update.md +180 -0
  23. package/docs/commands/liberica/orgs/list.md +62 -0
  24. package/docs/commands/liberica/positions/list.md +61 -0
  25. package/docs/commands/liberica/roles/list.md +67 -0
  26. package/docs/commands/liberica/users/create.md +170 -0
  27. package/docs/commands/liberica/users/get.md +151 -0
  28. package/docs/commands/liberica/users/list.md +175 -0
  29. package/package.json +37 -0
  30. package/src/commands/arabica/auth/index.ts +277 -0
  31. package/src/commands/arabica/auth/login.ts +5 -0
  32. package/src/commands/arabica/auth/logout.ts +5 -0
  33. package/src/commands/arabica/auth/register.ts +5 -0
  34. package/src/commands/arabica/auth/status.ts +5 -0
  35. package/src/commands/arabica/index.ts +23 -0
  36. package/src/commands/auth.ts +107 -0
  37. package/src/commands/context.ts +60 -0
  38. package/src/commands/liberica/auth/index.ts +170 -0
  39. package/src/commands/liberica/context/index.ts +43 -0
  40. package/src/commands/liberica/employees/create.ts +275 -0
  41. package/src/commands/liberica/employees/delete.ts +122 -0
  42. package/src/commands/liberica/employees/disable.ts +97 -0
  43. package/src/commands/liberica/employees/enable.ts +97 -0
  44. package/src/commands/liberica/employees/get.ts +115 -0
  45. package/src/commands/liberica/employees/index.ts +23 -0
  46. package/src/commands/liberica/employees/list.ts +131 -0
  47. package/src/commands/liberica/employees/update.ts +157 -0
  48. package/src/commands/liberica/index.ts +36 -0
  49. package/src/commands/liberica/orgs/index.ts +35 -0
  50. package/src/commands/liberica/positions/index.ts +30 -0
  51. package/src/commands/liberica/roles/index.ts +59 -0
  52. package/src/commands/liberica/users/create.ts +132 -0
  53. package/src/commands/liberica/users/delete.ts +49 -0
  54. package/src/commands/liberica/users/disable.ts +41 -0
  55. package/src/commands/liberica/users/enable.ts +30 -0
  56. package/src/commands/liberica/users/get.ts +46 -0
  57. package/src/commands/liberica/users/index.ts +27 -0
  58. package/src/commands/liberica/users/list.ts +68 -0
  59. package/src/commands/liberica/users/me.ts +42 -0
  60. package/src/commands/liberica/users/reset-password.ts +42 -0
  61. package/src/commands/liberica/users/update.ts +48 -0
  62. package/src/core/api/client.ts +825 -0
  63. package/src/core/auth/token-manager.ts +183 -0
  64. package/src/core/config/manager.ts +164 -0
  65. package/src/index.ts +37 -0
  66. package/src/types/employee.ts +102 -0
  67. package/src/types/index.ts +75 -0
  68. package/src/types/org.ts +25 -0
  69. package/src/types/position.ts +24 -0
  70. package/src/types/user.ts +64 -0
  71. package/tests/unit/commands/arabica/auth.test.ts +230 -0
  72. package/tests/unit/commands/liberica/auth.test.ts +175 -0
  73. package/tests/unit/commands/liberica/context.test.ts +98 -0
  74. package/tests/unit/commands/liberica/employees/create.test.ts +463 -0
  75. package/tests/unit/commands/liberica/employees/disable.test.ts +82 -0
  76. package/tests/unit/commands/liberica/employees/enable.test.ts +82 -0
  77. package/tests/unit/commands/liberica/employees/get.test.ts +111 -0
  78. package/tests/unit/commands/liberica/employees/list.test.ts +294 -0
  79. package/tests/unit/commands/liberica/employees/update.test.ts +210 -0
  80. package/tests/unit/config.test.ts +141 -0
  81. package/tests/unit/types.test.ts +195 -0
  82. package/tsconfig.json +20 -0
@@ -0,0 +1,811 @@
1
+ # Barista CLI 命令设计规范
2
+
3
+ ## 1. 文档目的
4
+
5
+ 本规范定义 Barista CLI 每个命令的设计文档格式。每个命令在开发前必须按此模板编写设计文档,明确引用后端代码位置。
6
+
7
+ ---
8
+
9
+ ## 2. 命令设计文档模板
10
+
11
+ 每个命令设计文档必须包含以下章节:
12
+
13
+ ```markdown
14
+ # 命令名称: barista <service> <resource> <action>
15
+
16
+ ## 2.1 命令元数据
17
+
18
+ | 字段 | 值 |
19
+ |------|-----|
20
+ | 完整命令 | `barista liberica orders create` |
21
+ | 功能描述 | 创建销售订单 |
22
+ | HTTP方法 | POST |
23
+ | 是否需要认证 | ✅ 是 / ⬜ 否 |
24
+ | 是否支持dry-run | ✅ 是 / ⬜ 否 |
25
+
26
+ ## 2.2 后端接口引用
27
+
28
+ ### Controller位置
29
+ ```
30
+ <coffee-liberica-end 或 coffee-arabica-end 相对路径>
31
+ └── <Controller类全路径>
32
+ └── <方法名>(@<MethodResource>)
33
+ └── 方法签名
34
+ ```
35
+
36
+ **实际示例:**
37
+ ```
38
+ coffee-liberica-end/
39
+ └── facade/liberica-facade-enterprise/
40
+ └── src/main/java/com/newpeak/liberica/facade/enterprise/controller/sales/
41
+ └── EnterpriseSalesOrderController.java
42
+ └── add(@PostResource(path = "/add"))
43
+ └── public ResponseData<SalesOrderResponse> add(
44
+ @RequestHeader("X-TENANT-ID") Long tenantId,
45
+ @RequestBody @Validated(BaseRequest.add.class) SalesOrderRequest request
46
+ )
47
+ ```
48
+
49
+ ### Request DTO位置
50
+ ```
51
+ <模块>/src/main/java/<包路径>/
52
+ └── <Request类名>.java
53
+ └── 核心字段(列出CLI会用到的)
54
+ ```
55
+
56
+ **实际示例:**
57
+ ```
58
+ coffee-liberica-end/
59
+ └── business/liberica-business-sales/sales-api/
60
+ └── src/main/java/com/newpeak/liberica/sales/api/pojo/request/
61
+ └── SalesOrderRequest.java
62
+ ├── clientCode: String (@NotBlank)
63
+ ├── clientName: String (@NotBlank)
64
+ ├── materialNo: String
65
+ ├── materialName: String
66
+ ├── purchaseNumber: BigDecimal
67
+ ├── deliveryDate: Date
68
+ └── salesOrderStatus: String
69
+ ```
70
+
71
+ ### Response DTO位置
72
+ ```
73
+ <模块>/src/main/java/<包路径>/
74
+ └── <Response类名>.java
75
+ └── 核心字段(列出CLI会返回的)
76
+ ```
77
+
78
+ **实际示例:**
79
+ ```
80
+ coffee-liberica-end/
81
+ └── business/liberica-business-sales/sales-api/
82
+ └── src/main/java/com/newpeak/liberica/sales/api/pojo/response/
83
+ └── SalesOrderResponse.java
84
+ ├── salesOrderId: Long
85
+ ├── salesOrderCode: String
86
+ ├── clientName: String
87
+ ├── materialName: String
88
+ └── salesOrderStatus: String
89
+ ```
90
+
91
+ ## 2.3 CLI参数设计
92
+
93
+ ### 命令结构
94
+ ```bash
95
+ barista <service> <resource> <action> [全局选项] [命令选项]
96
+ ```
97
+
98
+ ### 全局选项
99
+ | 选项 | 类型 | 说明 |
100
+ |------|------|------|
101
+ | `--env` | string | 目标环境(dev/test/prod-cn/prod-jp) |
102
+ | `--tenant` | string | 租户代码(仅Liberica) |
103
+ | `--dry-run` | boolean | 预览模式 |
104
+ | `--json` | boolean | JSON输出 |
105
+
106
+ ### 命令选项
107
+ | 选项 | 短选项 | 类型 | 必填 | 默认值 | 说明 | 对应DTO字段 |
108
+ |------|--------|------|------|--------|------|-------------|
109
+ | --client-code | -c | string | ✅ | - | 客户编码 | clientCode |
110
+ | --client-name | -n | string | ✅ | - | 客户名称 | clientName |
111
+ | --product-id | -p | string | ✅ | - | 产品号码 | materialNo |
112
+ | --quantity | -q | number | ✅ | - | 订购数量 | purchaseNumber |
113
+ | --due-date | -d | string | ⬜ | - | 交货日期(YYYY-MM-DD) | deliveryDate |
114
+ | --status | -s | string | ⬜ | pending | 订单状态 | salesOrderStatus |
115
+ | --remark | -r | string | ⬜ | - | 备注 | remark |
116
+
117
+ ### 位置参数与选项参数混合支持
118
+
119
+ CLI 命令应同时支持**位置参数**和**选项参数**,允许用户根据习惯灵活调用。
120
+
121
+ **命令结构:**
122
+ ```bash
123
+ barista <service> <resource> <action> [位置参数...] [选项]
124
+ ```
125
+
126
+ **设计原则:**
127
+ 1. 位置参数使用 `Commander.arguments()` 定义
128
+ 2. 选项参数使用 `.option()` 定义
129
+ 3. Action handler 中位置参数在前,options 对象在后
130
+ 4. 解析优先级:**选项参数 > 位置参数 > 默认值**
131
+
132
+ **实现示例:**
133
+ ```typescript
134
+ // 定义命令,同时支持位置参数和选项
135
+ program
136
+ .command('login')
137
+ .arguments('<env> [tenant] [username] [password]')
138
+ .option('--env <environment>', 'Environment')
139
+ .option('--tenant <tenant>', 'Tenant name')
140
+ .option('--username <username>', 'Username')
141
+ .option('--password <password>', 'Password')
142
+ .action(async (env, tenant, username, password, options) => {
143
+ // 解析:选项参数优先,其次位置参数,最后默认值
144
+ const resolvedEnv = options.env || env || defaultEnv;
145
+ const resolvedTenant = options.tenant || tenant || defaultTenant;
146
+ const resolvedUsername = options.username || username;
147
+ const resolvedPassword = options.password || password;
148
+ });
149
+ ```
150
+
151
+ **调用方式:**
152
+ ```bash
153
+ # 全位置参数
154
+ barista liberica auth login dev shanghai admin pass
155
+
156
+ # 全选项参数
157
+ barista liberica auth login --env dev --tenant shanghai --username admin --password pass
158
+
159
+ # 混合使用(常见)
160
+ barista liberica auth login dev --username admin --password pass
161
+
162
+ # 交互式(无参数)
163
+ barista liberica auth login
164
+ ```
165
+
166
+ ## 2.4 字段映射表
167
+
168
+ | CLI参数 | DTO字段 | 类型转换 | 验证规则 |
169
+ |---------|---------|----------|----------|
170
+ | --client-code | clientCode | 直接传递 | @NotBlank, max=255 |
171
+ | --client-name | clientName | 直接传递 | @NotBlank, max=255 |
172
+ | --product-id | materialNo | 直接传递 | - |
173
+ | --quantity | purchaseNumber | string→BigDecimal | @NotNull, >0 |
174
+ | --due-date | deliveryDate | string→Date | yyyy-MM-dd |
175
+ | --status | salesOrderStatus | 直接传递 | enum验证 |
176
+ | --remark | remark | 直接传递 | max=255 |
177
+
178
+ ## 2.5 错误码引用
179
+
180
+ ### ExceptionEnum位置
181
+ ```
182
+ <模块>/src/main/java/<包路径>/exception/enums/
183
+ └── <ExceptionEnum>.java
184
+ ```
185
+
186
+ **实际示例:**
187
+ ```
188
+ coffee-liberica-end/
189
+ └── business/liberica-business-sales/sales-api/
190
+ └── src/main/java/com/newpeak/liberica/sales/api/exception/enums/
191
+ └── SalesOrderExceptionEnum.java
192
+ ├── SALES_ORDER_NOT_EXIST("xxx", "销售订单不存在")
193
+ ├── SALES_ORDER_CODE_DUPLICATE("xxx", "销售订单编码重复")
194
+ └── ...
195
+ ```
196
+
197
+ ### Service层业务校验
198
+ ```
199
+ <模块>/src/main/java/<包路径>/business/
200
+ └── <Business类>.java
201
+ └── <方法名>()
202
+ └── 抛出异常的具体位置(行号或代码片段)
203
+ ```
204
+
205
+ **实际示例:**
206
+ ```
207
+ coffee-liberica-end/
208
+ └── business/liberica-business-sales/sales-business/
209
+ └── src/main/java/com/newpeak/liberica/sales/modular/business/
210
+ └── SalesOrderBusiness.java
211
+ └── add(SalesOrderRequest request)
212
+ ├── Line 85: 检查客户是否存在
213
+ │ └── throw new SalesException(ClientExceptionEnum.CLIENT_NOT_EXIST)
214
+ ├── Line 102: 检查产品是否存在
215
+ │ └── throw new MaterialException(MaterialExceptionEnum.MATERIAL_NOT_EXIST)
216
+ └── Line 128: 检查编码是否重复
217
+ └── throw new SalesException(SalesOrderExceptionEnum.SALES_ORDER_CODE_DUPLICATE)
218
+ ```
219
+
220
+ ### 已知错误码示例
221
+ | 错误码 | 错误消息 | 触发条件 |
222
+ |--------|----------|----------|
223
+ | xxx | 销售订单不存在 | 编辑/详情时ID不存在 |
224
+ | xxx | 销售订单编码重复 | 编码已存在 |
225
+ | xxx | 客户不存在 | clientCode无效 |
226
+ | xxx | 产品不存在 | materialNo无效 |
227
+
228
+ ## 2.6 权限检查
229
+
230
+ | 检查项 | 位置 | 说明 |
231
+ |--------|------|------|
232
+ | PermissionConstants | `.../constants/SalesOrderPermissionConstants.java` | ADD_SALES_ORDER |
233
+ | 注解 | `@PostResource(requiredPermission = true, requirePermissionCode = ...)` | Controller方法上 |
234
+
235
+ ## 2.7 公开接口声明(如适用)
236
+
237
+ 如果此接口支持公开访问(无需认证):
238
+
239
+ ```yaml
240
+ public_endpoints:
241
+ - service: "liberica"
242
+ path: "/api/enterprise/sales/salesOrder/publicList"
243
+ ```
244
+
245
+ ---
246
+
247
+ ## 3. 命令分类规范
248
+
249
+ ### 3.1 服务(service)命名
250
+ - `liberica` - Liberica生产管理
251
+ - `arabica` - Arabica销售平台
252
+
253
+ ### 3.2 资源(resource)命名
254
+ 使用名词复数形式:
255
+ - ✅ `orders` (订单)
256
+ - ✅ `products` (产品)
257
+ - ✅ `customers` (客户)
258
+ - ❌ `order` (不规范)
259
+ - ❌ `create-order` (动词不应出现在resource)
260
+
261
+ ### 3.3 动作(action)命名
262
+ 使用动词:
263
+ | 动作 | 用途 | HTTP方法 |
264
+ |------|------|----------|
265
+ | list | 列表查询 | GET |
266
+ | get | 详情查询 | GET |
267
+ | create | 创建 | POST |
268
+ | update | 更新 | POST/PUT |
269
+ | delete | 删除 | POST/DELETE |
270
+ | cancel | 取消 | POST |
271
+ | search | 搜索 | GET |
272
+
273
+ ---
274
+
275
+ ## 4. 文档存放位置
276
+
277
+ 命令设计文档存放在:
278
+ ```
279
+ coffee-barista-cli/
280
+ └── docs/
281
+ └── commands/
282
+ ├── liberica/
283
+ │ ├── orders-create.md
284
+ │ ├── orders-list.md
285
+ │ ├── orders-get.md
286
+ │ └── ...
287
+ ├── arabica/
288
+ │ ├── products-list.md
289
+ │ └── ...
290
+ └── cross/
291
+ └── ...
292
+ ```
293
+
294
+ ---
295
+
296
+ ## 5. 命令开发流程规范
297
+
298
+ ### 5.1 流程概览
299
+
300
+ 每个命令的开发必须遵循以下流程:
301
+
302
+ ```
303
+ ┌─────────────────────────────────────────────────────────────┐
304
+ │ Phase 1: 设计阶段 (必须完成) │
305
+ ├─────────────────────────────────────────────────────────────┤
306
+ │ 1. 编写设计文档 → 2. 技术评审 → 3. 设计文档归档 │
307
+ └─────────────────────────────────────────────────────────────┘
308
+
309
+ ┌─────────────────────────────────────────────────────────────┐
310
+ │ Phase 2: 开发阶段 │
311
+ ├─────────────────────────────────────────────────────────────┤
312
+ │ 4. 接口契约确认 → 5. 类型定义 → 6. 核心实现 → 7. 错误处理 │
313
+ └─────────────────────────────────────────────────────────────┘
314
+
315
+ ┌─────────────────────────────────────────────────────────────┐
316
+ │ Phase 3: 验证阶段 │
317
+ ├─────────────────────────────────────────────────────────────┤
318
+ │ 8. 单元测试 → 9. 集成测试 → 10. Code Review → 11. 合并 │
319
+ └─────────────────────────────────────────────────────────────┘
320
+ ```
321
+
322
+ ### 5.2 详细流程
323
+
324
+ #### Phase 1: 设计阶段
325
+
326
+ **Step 1: 编写设计文档** (预估: 30-60分钟)
327
+ - [ ] 按第2节模板编写设计文档
328
+ - [ ] 确认后端接口位置(查看Controller代码)
329
+ - [ ] 确认DTO字段(查看Request/Response类)
330
+ - [ ] 确认错误码(查看ExceptionEnum)
331
+ - [ ] 输出: `docs/commands/<service>/<resource>-<action>.md`
332
+
333
+ **Step 2: 技术评审** (预估: 15-30分钟)
334
+ - [ ] 自检清单:
335
+ - [ ] API路径正确性
336
+ - [ ] 字段映射完整性
337
+ - [ ] 必填/可选字段区分正确
338
+ - [ ] 错误场景覆盖
339
+ - [ ] 如有疑问,联系后端开发人员确认
340
+
341
+ **Step 3: 设计文档归档**
342
+ - [ ] 将设计文档提交到 Git
343
+ - [ ] 提交信息: `docs: add design doc for <service> <resource> <action>`
344
+
345
+ #### Phase 2: 开发阶段
346
+
347
+ **Step 4: 接口契约确认** (预估: 15分钟)
348
+ ```bash
349
+ # 使用curl或Postman测试后端接口
350
+ curl -X POST https://<env>/api/enterprise/sales/salesOrder/add \
351
+ -H "Authorization: <token>" \
352
+ -H "Content-Type: application/json" \
353
+ -d '{
354
+ "clientCode": "TEST001",
355
+ "clientName": "测试客户",
356
+ "materialNo": "MAT001",
357
+ "purchaseNumber": 100
358
+ }'
359
+ ```
360
+ - [ ] 确认接口可达
361
+ - [ ] 确认认证方式
362
+ - [ ] 记录实际响应格式
363
+
364
+ **Step 5: 类型定义** (预估: 20-30分钟)
365
+ - [ ] 在 `src/types/api.ts` 添加 TypeScript 接口
366
+ - [ ] 在 `src/core/api/<service>-client.ts` 添加方法签名
367
+ - [ ] 输出示例:
368
+ ```typescript
369
+ // src/types/api.ts
370
+ export interface CreateSalesOrderRequest {
371
+ clientCode: string;
372
+ clientName: string;
373
+ materialNo: string;
374
+ purchaseNumber: number;
375
+ deliveryDate?: string;
376
+ }
377
+
378
+ export interface SalesOrderResponse {
379
+ salesOrderId: number;
380
+ salesOrderCode: string;
381
+ // ...
382
+ }
383
+
384
+ // src/core/api/liberica-client.ts
385
+ async createOrder(data: CreateSalesOrderRequest): Promise<SalesOrderResponse>
386
+ ```
387
+
388
+ **Step 6: 核心实现** (预估: 30-60分钟)
389
+ - [ ] 创建命令文件: `src/commands/<service>/<resource>/<action>.ts`
390
+ - [ ] 实现命令逻辑:
391
+ ```typescript
392
+ export async function createOrderAction(options: CreateOrderOptions): Promise<void> {
393
+ // 1. 获取API客户端
394
+ const api = await ContextAwareAPIFactory.getLibericaClient();
395
+
396
+ // 2. 构建请求参数
397
+ const request: CreateSalesOrderRequest = {
398
+ clientCode: options.clientCode,
399
+ clientName: options.clientName,
400
+ // ...
401
+ };
402
+
403
+ // 3. 执行API调用(支持dry-run)
404
+ const result = await api.createOrder(request, options.dryRun);
405
+
406
+ // 4. 格式化输出
407
+ formatOutput(result, { command: 'liberica orders create' });
408
+ }
409
+ ```
410
+ - [ ] 注册命令: 在 `src/commands/<service>/<resource>/index.ts` 注册
411
+
412
+ **Step 7: 错误处理** (预估: 20-30分钟)
413
+ - [ ] 实现错误捕获和转换
414
+ - [ ] 映射后端错误码到友好提示
415
+ - [ ] 添加错误修复建议
416
+ - [ ] 示例:
417
+ ```typescript
418
+ try {
419
+ await api.createOrder(request);
420
+ } catch (error) {
421
+ if (error.code === 'SALES_ORDER_CODE_DUPLICATE') {
422
+ throw new CLIError(
423
+ '订单编码已存在',
424
+ 'DUPLICATE_CODE',
425
+ { fix: '请使用不同的编码或使用 --code 参数指定' }
426
+ );
427
+ }
428
+ // ...
429
+ }
430
+ ```
431
+
432
+ #### Phase 3: 验证阶段
433
+
434
+ **Step 8: 单元测试** (预估: 30-45分钟)
435
+ - [ ] 创建测试文件: `tests/unit/commands/<service>/<resource>-<action>.test.ts`
436
+ - [ ] 测试场景:
437
+ - [ ] 正常创建
438
+ - [ ] 缺少必填参数
439
+ - [ ] 无效参数值
440
+ - [ ] dry-run模式
441
+ - [ ] 错误响应处理
442
+
443
+ **Step 9: 集成测试** (预估: 20-30分钟)
444
+ ```bash
445
+ # 在dev环境测试
446
+ barista context use-env dev
447
+ barista auth login --service liberica --env dev --tenant companya
448
+
449
+ # 测试命令
450
+ barista liberica orders create \
451
+ --client-code TEST001 \
452
+ --client-name "测试客户" \
453
+ --product-id MAT001 \
454
+ --quantity 100 \
455
+ --dry-run
456
+
457
+ # 确认dry-run输出正确后,实际执行
458
+ barista liberica orders create \
459
+ --client-code TEST001 \
460
+ --client-name "测试客户" \
461
+ --product-id MAT001 \
462
+ --quantity 100
463
+ ```
464
+ - [ ] 记录测试证据(截图或输出)
465
+ - [ ] 保存到: `.sisyphus/evidence/<command>-test.md`
466
+
467
+ **Step 10: Code Review** (预估: 15-30分钟)
468
+ - [ ] 自检清单:
469
+ - [ ] 代码符合项目规范(ESLint通过)
470
+ - [ ] 类型定义完整
471
+ - [ ] 错误处理完善
472
+ - [ ] 文档注释清晰
473
+ - [ ] 提交PR,指派Reviewer
474
+
475
+ **Step 11: 合并与发布**
476
+ - [ ] 通过CI/CD检查
477
+ - [ ] 合并到main分支
478
+ - [ ] 更新CHANGELOG
479
+
480
+ ### 5.3 开发检查清单
481
+
482
+ #### 实现前检查
483
+ - [ ] 设计文档已编写并评审通过
484
+ - [ ] 后端接口已确认可用
485
+ - [ ] DTO字段已与后端对齐
486
+
487
+ #### 实现中检查
488
+ - [ ] 使用设计文档中的字段映射
489
+ - [ ] 参数验证与后端一致
490
+ - [ ] 支持 `--dry-run`(如适用)
491
+ - [ ] 错误处理覆盖已知场景
492
+
493
+ #### 实现后检查
494
+ - [ ] 单元测试通过率 100%
495
+ - [ ] 集成测试通过
496
+ - [ ] 文档已更新
497
+ - [ ] CHANGELOG已更新
498
+
499
+ ### 5.4 时间估算参考
500
+
501
+ | 步骤 | 预估时间 | 备注 |
502
+ |------|---------|------|
503
+ | 设计文档 | 30-60min | 复杂命令需要更长时间 |
504
+ | 类型定义 | 20-30min | 依赖DTO复杂度 |
505
+ | 核心实现 | 30-60min | 简单CRUD较快 |
506
+ | 错误处理 | 20-30min | 需要查看Service代码 |
507
+ | 单元测试 | 30-45min | TDD可合并到实现中 |
508
+ | 集成测试 | 20-30min | 需要真实环境 |
509
+ | Code Review | 15-30min | 包含修改时间 |
510
+ | **总计** | **2.5-5h** | 简单命令约2.5h,复杂命令约5h |
511
+
512
+ ### 5.5 交付物清单
513
+
514
+ 每个命令开发完成后,必须包含:
515
+
516
+ ```
517
+ deliverables/
518
+ ├── docs/commands/<service>/<resource>-<action>.md # 设计文档
519
+ ├── src/
520
+ │ ├── commands/<service>/<resource>/<action>.ts # 命令实现
521
+ │ ├── types/api.ts # 类型定义(更新)
522
+ │ └── core/api/<service>-client.ts # API客户端(更新)
523
+ ├── tests/
524
+ │ └── unit/commands/<service>/<resource>-<action>.test.ts # 单元测试
525
+ └── .sisyphus/evidence/
526
+ └── <resource>-<action>-test.md # 集成测试证据
527
+ ```
528
+
529
+ ---
530
+
531
+ ## 6. 示例:完整设计文档
532
+
533
+ ### 6.1 示例:liberica auth login 命令
534
+
535
+ #### 命令元数据
536
+
537
+ | 字段 | 值 |
538
+ |------|-----|
539
+ | 完整命令 | `barista liberica auth login` |
540
+ | 功能描述 | 登录 Liberica 租户账户 |
541
+ | HTTP方法 | POST |
542
+ | 是否需要认证 | ⬜ 否(登录接口无需认证) |
543
+ | 是否支持dry-run | ⬜ 否(登录操作不适合dry-run) |
544
+
545
+ #### 后端接口引用
546
+
547
+ **Controller位置:**
548
+ ```
549
+ coffee-liberica-end/
550
+ └── facade/liberica-facade-auth/
551
+ └── src/main/java/com/newpeak/liberica/facade/auth/
552
+ └── controller/AuthController.java
553
+ └── login(@PostResource(path = "/login"))
554
+ └── public ResponseData<LoginResponse> login(
555
+ @RequestBody AuthLoginRequest request
556
+ )
557
+ ```
558
+
559
+ **Request DTO:**
560
+ ```
561
+ coffee-liberica-end/
562
+ └── business/liberica-business-auth/auth-api/
563
+ └── src/main/java/com/newpeak/liberica/auth/api/pojo/request/
564
+ └── AuthLoginRequest.java
565
+ ├── username: String (@NotBlank)
566
+ ├── password: String (@NotBlank)
567
+ └── tenant: String
568
+ ```
569
+
570
+ **Response DTO:**
571
+ ```
572
+ coffee-liberica-end/
573
+ └── business/liberica-business-auth/auth-api/
574
+ └── src/main/java/com/newpeak/liberica/auth/api/pojo/response/
575
+ └── LoginResponse.java
576
+ ├── token: String
577
+ └── expiresAt: String (optional)
578
+ ```
579
+
580
+ #### CLI参数设计
581
+
582
+ **命令结构:**
583
+ ```
584
+ barista liberica auth login [env] [tenant] [username] [password] [options]
585
+ ```
586
+
587
+ **Arguments (位置参数):**
588
+ | 参数 | 类型 | 必填 | 说明 |
589
+ |------|------|------|------|
590
+ | env | string | ⬜ | 目标环境 (dev\|test\|prod-cn\|prod-jp) |
591
+ | tenant | string | ⬜ | 租户名称 |
592
+ | username | string | ⬜ | 用户名 |
593
+ | password | string | ⬜ | 密码 |
594
+
595
+ **Options (选项参数):**
596
+ | 选项 | 类型 | 必填 | 默认值 | 说明 |
597
+ |------|------|------|--------|------|
598
+ | --env | string | ⬜ | 当前上下文 | 目标环境 |
599
+ | --tenant | string | ⬜ | 当前上下文 | 租户名称 |
600
+ | --username | string | ⬜ | 交互输入 | 用户名 |
601
+ | --password | string | ⬜ | 交互输入 | 密码 |
602
+
603
+ #### 字段映射表
604
+
605
+ | CLI参数 | DTO字段 | 类型转换 | 验证规则 |
606
+ |---------|---------|----------|----------|
607
+ | --tenant | tenant | 直接传递 | 可选 |
608
+ | --username | username | 直接传递 | @NotBlank |
609
+ | --password | password | 直接传递 | @NotBlank |
610
+
611
+ #### 错误码引用
612
+
613
+ **Service层业务校验:**
614
+ ```
615
+ coffee-liberica-end/
616
+ └── business/liberica-business-auth/auth-business/
617
+ └── src/main/java/com/newpeak/liberica/auth/modular/business/
618
+ └── AuthBusiness.java
619
+ └── login(AuthLoginRequest request)
620
+ ├── Line 45: 验证用户是否存在
621
+ │ └── throw new AuthException(AuthExceptionEnum.USER_NOT_EXIST)
622
+ └── Line 62: 验证密码是否正确
623
+ └── throw new AuthException(AuthExceptionEnum.PASSWORD_ERROR)
624
+ ```
625
+
626
+ **已知错误码:**
627
+ | 错误码 | 错误消息 | 触发条件 |
628
+ |--------|----------|----------|
629
+ | USER_NOT_EXIST | 用户不存在 | 用户名未注册 |
630
+ | PASSWORD_ERROR | 密码错误 | 密码不匹配 |
631
+
632
+ #### 公开接口声明
633
+
634
+ ```yaml
635
+ public_endpoints:
636
+ - service: "liberica"
637
+ path: "/api/v1/auth/login"
638
+ ```
639
+
640
+ #### 实现要点
641
+
642
+ 1. **交互式补全**:tenant/username/password 未提供时,使用 inquirer 交互输入
643
+ 2. **Token存储**:登录成功后调用 `tokenManager.setToken()` 存入系统密钥链
644
+ 3. **上下文更新**:调用 `configManager.setTenant()` 更新默认租户
645
+ 4. **错误处理**:区分网络错误和业务错误,业务错误显示友好提示
646
+
647
+ #### 实现代码
648
+
649
+ ```typescript
650
+ // src/commands/liberica/auth/index.ts
651
+ export function createLibericaAuthCommand(): Command {
652
+ const authCommand = new Command('auth');
653
+ authCommand.description('Manage Liberica authentication');
654
+
655
+ authCommand
656
+ .command('login')
657
+ .description('Login to Liberica')
658
+ .arguments('<env> [tenant] [username] [password]')
659
+ .option('--env <environment>', 'Environment (dev|test|prod-cn|prod-jp)')
660
+ .option('--tenant <tenant>', 'Tenant name')
661
+ .option('--username <username>', 'Username')
662
+ .option('--password <password>', 'Password')
663
+ .action(async (env, tenant, username, password, options) => {
664
+ const context = configManager.getCurrentContext();
665
+ const environment = (options.env as Environment) || env || context.environment;
666
+ let resolvedTenant = options.tenant || tenant || context.tenant;
667
+
668
+ if (!resolvedTenant) {
669
+ const { tenant: inputTenant } = await inquirer.prompt([
670
+ { type: 'input', name: 'tenant', message: 'Enter tenant name:' }
671
+ ]);
672
+ resolvedTenant = inputTenant;
673
+ }
674
+
675
+ let resolvedUsername = options.username || username;
676
+ let resolvedPassword = options.password || password;
677
+
678
+ if (!resolvedUsername) {
679
+ const { username: inputUsername } = await inquirer.prompt([
680
+ { type: 'input', name: 'username', message: 'Enter username:' }
681
+ ]);
682
+ resolvedUsername = inputUsername;
683
+ }
684
+
685
+ if (!resolvedPassword) {
686
+ const { password: inputPassword } = await inquirer.prompt([
687
+ { type: 'password', name: 'password', message: 'Enter password:' }
688
+ ]);
689
+ resolvedPassword = inputPassword;
690
+ }
691
+
692
+ const response = await apiClient.login('liberica', environment, resolvedTenant, resolvedUsername, resolvedPassword);
693
+
694
+ if (response.success && response.data) {
695
+ await tokenManager.setToken(
696
+ { service: 'liberica', environment, tenant: resolvedTenant },
697
+ response.data.token
698
+ );
699
+ await configManager.setTenant(resolvedTenant);
700
+ console.log(chalk.green('\n✓ Login successful'));
701
+ } else {
702
+ console.error(chalk.red(`\n✗ Login failed: ${response.error?.message}\n`));
703
+ process.exit(1);
704
+ }
705
+ });
706
+
707
+ return authCommand;
708
+ }
709
+ ```
710
+
711
+ **调用方式:**
712
+ ```bash
713
+ # 全位置参数
714
+ barista liberica auth login dev shanghai admin pass
715
+
716
+ # 全选项参数
717
+ barista liberica auth login --env dev --tenant shanghai --username admin --password pass
718
+
719
+ # 混合
720
+ barista liberica auth login dev --username admin --password pass
721
+
722
+ # 交互式
723
+ barista liberica auth login
724
+ ```
725
+
726
+ ---
727
+
728
+ ### 6.2 示例:liberica context show 命令
729
+
730
+ #### 命令元数据
731
+
732
+ | 字段 | 值 |
733
+ |------|-----|
734
+ | 完整命令 | `barista liberica context show` |
735
+ | 功能描述 | 显示当前 Liberica 上下文 |
736
+ | HTTP方法 | 无(仅读取本地配置) |
737
+ | 是否需要认证 | ⬜ 否 |
738
+ | 是否支持dry-run | ⬜ 否 |
739
+
740
+ #### 实现要点
741
+
742
+ 1. **无API调用**:仅读取 `configManager.getCurrentContext()` 和 `tokenManager.getToken()`
743
+ 2. **Token状态检查**:检查密钥链中是否存在有效Token
744
+ 3. **格式化输出**:使用 chalk 彩色输出当前环境、租户、认证状态
745
+
746
+ #### 实现代码
747
+
748
+ ```typescript
749
+ // src/commands/liberica/context/index.ts
750
+ export function createLibericaContextCommand(): Command {
751
+ const contextCommand = new Command('context');
752
+ contextCommand.description('Manage Liberica context (tenant, environment)');
753
+
754
+ contextCommand
755
+ .command('show')
756
+ .description('Show current Liberica context')
757
+ .action(async () => {
758
+ const context = configManager.getCurrentContext();
759
+ const token = await tokenManager.getToken({
760
+ service: 'liberica',
761
+ environment: context.environment,
762
+ tenant: context.tenant,
763
+ });
764
+
765
+ console.log(chalk.bold('\n📋 Liberica Context\n'));
766
+ console.log(` ${chalk.gray('Environment:')} ${chalk.green(context.environment)}`);
767
+ console.log(` ${chalk.gray('Tenant:')} ${chalk.green(context.tenant)}`);
768
+ console.log(
769
+ ` ${chalk.gray('Auth Status:')} ${token ? chalk.green('✓ Logged in') : chalk.red('✗ Not logged in')}`
770
+ );
771
+ });
772
+
773
+ return contextCommand;
774
+ }
775
+ ```
776
+
777
+ ---
778
+
779
+ ### 6.3 模式总结
780
+
781
+ | 命令类型 | 特征 | 实现模式 |
782
+ |----------|------|----------|
783
+ | **认证类** (login, logout) | 调用API、存储Token | 使用 `apiClient.login()` + `tokenManager.setToken()` |
784
+ | **状态类** (status, show) | 读取配置/密钥链 | 使用 `configManager` + `tokenManager.getToken()` |
785
+ | **列表类** (list) | 调用API、表格输出 | 使用 `axios.get()` + `cli-table3` |
786
+ | **写入类** (create, update, delete) | 调用API、支持dry-run | API调用 + dry-run预览 + 确认提示 |
787
+
788
+ #### 核心模块依赖
789
+
790
+ ```
791
+ src/
792
+ ├── core/
793
+ │ ├── config/manager.ts # 配置管理 (getCurrentContext, setTenant, getEnvironmentUrl)
794
+ │ ├── auth/token-manager.ts # Token存储 (getToken, setToken, deleteToken, findAllTokens)
795
+ │ └── api/client.ts # API客户端 (login, createAPIClient)
796
+ │ └── types/index.ts # 类型定义 (Environment, Service, Context, Config)
797
+ └── commands/
798
+ └── {service}/
799
+ └── {resource}.ts # 命令实现
800
+ ```
801
+
802
+ #### 导入路径规范
803
+
804
+ ```typescript
805
+ import { configManager } from '../../../core/config/manager.js';
806
+ import { tokenManager } from '../../../core/auth/token-manager.js';
807
+ import { apiClient } from '../../../core/api/client.js';
808
+ import { Environment } from '../../../types/index.js';
809
+ ```
810
+
811
+ **注意**:必须使用 `.js` 扩展名,即使源文件是 `.ts`