1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
//! `str` CLI 入口。
use std::path::PathBuf;
use clap::{Parser, Subcommand};
use str_format::cmd;
use str_format::error::{Error, Result};
#[derive(Parser)]
#[command(
name = "str",
version,
about = "STR 结构化树资源格式(.str)工具链",
long_about = "STR 是目录 bundle 式的结构化树资源格式:深度 1 为独立节点,深度 ≥2 为关联分支,\n任意层级均可承载任意文件;每个分支的 `._meta`(TOML)记录元信息与内容清单。"
)]
struct Cli {
#[command(subcommand)]
cmd: Cmd,
}
#[derive(Subcommand)]
enum Cmd {
/// 创建新的 .str bundle(生成 ROOT `._meta` 与 `._schema/`)
Init {
/// 目标目录(缺省为当前路径;未以 .str 结尾时自动追加 `.str`)
dir: Option<PathBuf>,
/// bundle 短名
#[arg(long)]
name: Option<String>,
/// 标题
#[arg(long)]
title: Option<String>,
/// 一句话摘要
#[arg(long)]
summary: Option<String>,
/// `policies.id_version`:生成的 UUID 版本(4 或 7,缺省 7)
#[arg(long, default_value_t = 7)]
id_version: usize,
},
/// 全量校验(规范第 6 章全部错误码)
Validate {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 把告警也视为失败(CI 用)
#[arg(long)]
strict: bool,
/// 输出 JSON
#[arg(long)]
json: bool,
/// 校验前先执行一次 sync 修正清单
#[arg(long)]
fix_manifest: bool,
},
/// 渲染分支树(含跨枝关联线)
Tree {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 最大渲染深度
#[arg(long)]
depth: Option<usize>,
/// 显示 `refs` 关联线
#[arg(long)]
show_refs: bool,
/// 显示各分支的内容清单(`entries[]`,子分支行除外)
#[arg(long)]
show_entries: bool,
/// 用纯 ASCII 制表符渲染(终端字体缺字时用)
#[arg(long)]
ascii: bool,
},
/// 列出某分支的内容清单
Ls {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 分支 id(缺省为当前节点:`[dir]` 即 bundle 根时为 ROOT,指向分支目录时为该分支)
uuid: Option<String>,
/// `--uuid` 选项形式(等价于位置参数,保留兼容)
#[arg(long = "uuid", conflicts_with = "uuid")]
uuid_opt: Option<String>,
/// 直接读磁盘而非读清单
#[arg(long)]
raw: bool,
},
/// 打印某分支的 `._meta`(归一化 JSON)
Show {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 分支 id(缺省为当前节点:`[dir]` 即 bundle 根时为 ROOT,指向分支目录时为该分支)
uuid: Option<String>,
/// 附带 payload 正文
#[arg(long)]
full: bool,
},
/// 独立节点操作(深度 1)
Node {
#[command(subcommand)]
cmd: NodeCmd,
},
/// 关联分支操作(任意深度)
Branch {
#[command(subcommand)]
cmd: BranchCmd,
},
/// 跨枝关联线操作
Ref {
#[command(subcommand)]
cmd: RefCmd,
},
/// 分支自身元信息字段(`type` / `title` / `summary` / `name` / `tags`)
Meta {
#[command(subcommand)]
cmd: MetaCmd,
},
/// `entries[]` 条目字段
Entry {
#[command(subcommand)]
cmd: EntryCmd,
},
/// `[[authors]]` 协作记录
Author {
#[command(subcommand)]
cmd: AuthorCmd,
},
/// 规范版本声明(bundle 级:`._meta.spec`)
Spec {
#[command(subcommand)]
cmd: SpecCmd,
},
/// 用磁盘实际状态修正 `entries` 与指纹
Sync {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 只显示将要发生的变更
#[arg(long)]
dry_run: bool,
},
/// 按规范键序 / 表序重写 `._meta`(保注释)
Fmt {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 只检查是否需要规范化
#[arg(long)]
check: bool,
/// 丢弃整行注释(默认保留)
#[arg(long)]
strip_comments: bool,
},
/// 输出归一化 JSON(供外部 Schema 工具 / AI 使用)
Norm {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 分支 id(缺省为当前节点:`[dir]` 即 bundle 根时为 ROOT,指向分支目录时为该分支)
uuid: Option<String>,
/// 输出目标:`-` 为 stdout(缺省),其余为文件路径
#[arg(long)]
out: Option<String>,
},
/// 生成供 AI 使用的上下文片段
Context {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 分支 id(缺省为当前节点:`[dir]` 即 bundle 根时为 ROOT,指向分支目录时为该分支)
uuid: Option<String>,
/// 下钻层数
#[arg(long, default_value_t = 2)]
depth: usize,
/// 字符预算
#[arg(long, default_value_t = 8000)]
budget: usize,
},
/// 导出为单一文件(只读、派生)
Export {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 输出格式:json / toml
#[arg(long, default_value = "json")]
format: String,
/// 最大导出深度
#[arg(long)]
depth: Option<usize>,
/// 输出目标:`-` 为 stdout(缺省),其余为文件路径(不得落在 bundle 内部)
#[arg(long)]
out: Option<String>,
},
/// 平台适配:macOS 设置 bundle 位并让 `._meta` 可见
Reveal {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
},
/// 列出全部错误码
Codes,
}
#[derive(Subcommand)]
enum NodeCmd {
/// 新增独立节点(深度 1)
Add {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 实体类型,如 crm.customer
#[arg(long = "type")]
type_: Option<String>,
/// 标题
#[arg(long)]
title: Option<String>,
/// 摘要
#[arg(long)]
summary: Option<String>,
},
}
#[derive(Subcommand)]
enum BranchCmd {
/// 在指定分支下新增关联分支
Add {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 锚点分支 id(缺省为当前节点;真 ROOT 的直接子分支应改用 `node add`)
anchor: Option<String>,
/// 类型
#[arg(long = "type")]
type_: Option<String>,
/// 标题
#[arg(long)]
title: Option<String>,
/// 摘要
#[arg(long)]
summary: Option<String>,
/// 排序键
#[arg(long)]
order: Option<i64>,
},
/// 删除关联分支(含全部下级)
Rm {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 分支 id(缺省为 ROOT;ROOT 不可删除)
uuid: Option<String>,
/// 确认删除
#[arg(long)]
force: bool,
/// 递归删除下级(规范 §9 的写法;本命令**始终**递归,该旗标为兼容而接受)
#[arg(long)]
recursive: bool,
},
}
#[derive(Subcommand)]
enum RefCmd {
/// 新增跨枝关联线
Add {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 源分支 id(缺省为当前节点)
uuid: Option<String>,
/// 目标分支 id
#[arg(long)]
target: String,
/// 关联语义
#[arg(long, default_value = "related")]
rel: String,
/// 标签
#[arg(long)]
title: Option<String>,
/// 备注
#[arg(long)]
note: Option<String>,
},
/// 删除关联线
Rm {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 关联线 id(规范 §9 的位置参数形式)
ref_id: Option<String>,
/// 源分支 id(缺省:在整棵树上定位该关联线)
#[arg(long)]
uuid: Option<String>,
/// 关联线 id 的选项形式(等价于位置参数,保留兼容)
#[arg(long = "ref", conflicts_with = "ref_id")]
ref_opt: Option<String>,
},
}
#[derive(Subcommand)]
enum MetaCmd {
/// 设置分支自身的元信息字段(空串表示移除该字段)
Set {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 分支 id(缺省为当前节点:`[dir]` 即 bundle 根时为 ROOT,指向分支目录时为该分支)
uuid: Option<String>,
/// 实体类型,如 crm.customer(空串移除)
#[arg(long = "type")]
type_: Option<String>,
/// 标题(空串移除)
#[arg(long)]
title: Option<String>,
/// 摘要(空串移除)
#[arg(long)]
summary: Option<String>,
/// bundle 短名(仅 root 有效,空串移除)
#[arg(long)]
name: Option<String>,
/// 标签(逗号分隔,可重复;空串清空)
#[arg(long, value_delimiter = ',')]
tags: Option<Vec<String>>,
},
}
#[derive(Subcommand)]
enum EntryCmd {
/// 设置某分支 `entries[]` 中一条目的字段(空串表示移除该字段)
Set {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 条目所在分支 id(缺省为当前节点)
uuid: Option<String>,
/// 条目路径(单段名,与子项目录名/文件名一致)
#[arg(long = "path")]
path: String,
/// 子分支类型(空串移除)
#[arg(long = "type")]
type_: Option<String>,
/// 展示名(空串移除)
#[arg(long)]
title: Option<String>,
/// 子分支摘要(空串移除)
#[arg(long)]
summary: Option<String>,
/// 备注(空串移除)
#[arg(long)]
note: Option<String>,
/// 同层排序键(规范 §4.6)
#[arg(long)]
order: Option<i64>,
},
}
#[derive(Subcommand)]
enum AuthorCmd {
/// 新增 / 覆盖一条 `[[authors]]`(按 id 去重)
Add {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 分支 id(缺省为当前节点:`[dir]` 即 bundle 根时为 ROOT,指向分支目录时为该分支)
uuid: Option<String>,
/// 稳定标识符(SSO sub / 邮箱 hash;禁止用显示名)
#[arg(long)]
id: String,
/// 展示名
#[arg(long)]
name: Option<String>,
/// 角色:owner / editor / viewer / agent
#[arg(long)]
role: String,
/// 参与时间(offset date-time,缺省为当前时间)
#[arg(long)]
at: Option<String>,
},
/// 按 id 删除一条 `[[authors]]`
Rm {
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 分支 id(缺省为当前节点:`[dir]` 即 bundle 根时为 ROOT,指向分支目录时为该分支)
uuid: Option<String>,
/// 稳定标识符
#[arg(long)]
id: String,
},
}
#[derive(Subcommand)]
enum SpecCmd {
/// 把整份 bundle 的 `spec` 统一改写为目标版本(幂等;从此改 `spec` 不再需要手改 `._meta`)
Set {
/// 目标规范版本,如 1.10.0(`str` 主版本固定为 1;可用 `v` 前缀)
version: String,
/// bundle 目录(缺省为当前目录)
#[arg(default_value = ".")]
dir: PathBuf,
/// 只显示将要发生的变更
#[arg(long)]
dry_run: bool,
},
}
fn dispatch(cmd: Cmd) -> Result<i32> {
match cmd {
Cmd::Init {
dir,
name,
title,
summary,
id_version,
} => {
// `[dir]` 缺省为当前路径:仍按「未以 `.str` 结尾则追加」定名,
// 故在 `foo/` 里执行 `str init` 创建的是 `foo.str`(而非在 `.` 里生成 `..str`)。
let dir =
dir.unwrap_or_else(|| std::env::current_dir().unwrap_or_else(|_| PathBuf::from(".")));
cmd::init(&dir, name, title, summary, id_version)?;
Ok(0)
}
Cmd::Validate {
dir,
strict,
json,
fix_manifest,
} => cmd::validate(&dir, strict, json, fix_manifest),
Cmd::Tree {
dir,
depth,
show_refs,
show_entries,
ascii,
} => {
cmd::tree(&dir, depth, show_refs, show_entries, ascii)?;
Ok(0)
}
Cmd::Ls {
dir,
uuid,
uuid_opt,
raw,
} => {
cmd::ls(&dir, uuid.or(uuid_opt), raw)?;
Ok(0)
}
Cmd::Show { dir, uuid, full } => {
cmd::show(&dir, uuid, full)?;
Ok(0)
}
Cmd::Node { cmd } => match cmd {
NodeCmd::Add {
dir,
type_,
title,
summary,
} => {
cmd::node_add(&dir, type_, title, summary)?;
Ok(0)
}
},
Cmd::Branch { cmd } => match cmd {
BranchCmd::Add {
dir,
anchor,
type_,
title,
summary,
order,
} => {
cmd::branch_add(&dir, anchor, type_, title, summary, order)?;
Ok(0)
}
BranchCmd::Rm {
dir,
uuid,
force,
// 删除**总是**递归(`remove_dir_all`),该旗标仅为兼容规范 §9 的写法而接受
recursive: _,
} => {
cmd::branch_rm(&dir, uuid, force)?;
Ok(0)
}
},
Cmd::Ref { cmd } => match cmd {
RefCmd::Add {
dir,
uuid,
target,
rel,
title,
note,
} => {
cmd::ref_add(&dir, uuid, &target, rel, title, note)?;
Ok(0)
}
RefCmd::Rm {
dir,
ref_id,
uuid,
ref_opt,
} => {
let ref_id = ref_id.or(ref_opt).ok_or_else(|| {
Error::BadArg("缺少关联线 id(位置参数 `<REF_ID>` 或 `--ref <REF_ID>`)".into())
})?;
cmd::ref_rm(&dir, uuid, &ref_id)?;
Ok(0)
}
},
Cmd::Meta { cmd } => match cmd {
MetaCmd::Set {
dir,
uuid,
type_,
title,
summary,
name,
tags,
} => {
cmd::meta_set(&dir, uuid, type_, title, summary, name, tags)?;
Ok(0)
}
},
Cmd::Entry { cmd } => match cmd {
EntryCmd::Set {
dir,
uuid,
path,
type_,
title,
summary,
note,
order,
} => {
cmd::entry_set(
&dir,
uuid,
&path,
&cmd::EntryPatch {
type_,
title,
summary,
note,
order,
},
)?;
Ok(0)
}
},
Cmd::Author { cmd } => match cmd {
AuthorCmd::Add {
dir,
uuid,
id,
name,
role,
at,
} => {
cmd::author_add(&dir, uuid, id, name, role, at)?;
Ok(0)
}
AuthorCmd::Rm { dir, uuid, id } => {
cmd::author_rm(&dir, uuid, &id)?;
Ok(0)
}
},
Cmd::Spec { cmd } => match cmd {
SpecCmd::Set {
dir,
version,
dry_run,
} => {
cmd::spec_set(&dir, &version, dry_run)?;
Ok(0)
}
},
Cmd::Sync { dir, dry_run } => {
cmd::sync(&dir, dry_run)?;
Ok(0)
}
Cmd::Fmt {
dir,
check,
strip_comments,
} => cmd::fmt(&dir, check, strip_comments),
Cmd::Norm { dir, uuid, out } => {
cmd::norm(&dir, uuid, out)?;
Ok(0)
}
Cmd::Context {
dir,
uuid,
depth,
budget,
} => {
cmd::context(&dir, uuid, depth, budget)?;
Ok(0)
}
Cmd::Export {
dir,
format,
depth,
out,
} => {
cmd::export(&dir, format, depth, out)?;
Ok(0)
}
Cmd::Reveal { dir } => {
cmd::reveal(&dir)?;
Ok(0)
}
Cmd::Codes => {
cmd::list_codes();
Ok(0)
}
}
}
fn main() -> std::process::ExitCode {
let cli = Cli::parse();
match dispatch(cli.cmd) {
Ok(code) => std::process::ExitCode::from(code as u8),
Err(e) => {
eprintln!("str: {e}");
let code = match e {
Error::NotFound(_) | Error::BadArg(_) => 2,
Error::Io { .. } => 3,
Error::Validation(_) | Error::Other(_) => 1,
};
std::process::ExitCode::from(code)
}
}
}